Enable discussions

[jack-burridge-cfh]

Hello,
I know this isn't an issue but I didn't know where to put it. There are a few things I'd like to discuss:

• Nested tables, and morerows/morecols support
• Wiki-like index as an option, I find myself adding this to a lot of my conf.py

def rst_file_transform(docname: str) -> str:
    docname = "Home" if docname == "index" else docname
    return f"{docname}.rst"


def rst_link_transform(docname: str) -> str:
    return "Home" if docname == "index" else docname

• _Sidebar option would also be really nice
• Document names as titles so it looks nicer on some wikis

But apart from tables, all the others are opinionated so it may be good to discuss. So would it be possible to enable discussions?

[macfreek]

Hi @jack-burridge-cfh, thanks for the suggestions. Support for nested markup would certainly be great, but I've found that this is rather error-prone, while I'm not using it very often. I gladly accept pull request that tries to improve the situation, but request that they are associated with a few tests to ensure they keep working. Sorry for not being able to promise more than that at this point.

As for the wiki-like naming, I'm a bit cautious to move too much logic to restbuilder. Application-logic like naming of documents seem appropriate in conf.py, but if you have a suggestion to make restbuilder more flexible (perhaps a mapping table for document titles <-> file names?), which reduces the effort you have to spend, I will consider it.

As for the last two suggestions, at this moment I can only promise to look into pull requests, but perhaps a bit more explanation is in order, before we add too much code to restbuilder which is only applicable to wiki output.

[jack-burridge-cfh]

@macfreek I helped write the initial tests so willing to add more 😁 very much a fan of testing! (Different company different username)

Wiki-like index I'm sure I could write. Plus a push to wiki if you were to enable it (have docs that prove the consent kinda thing).

The last two require quite a bit I think, I'll try and come up with ways of doing it and raising PRs to review, see if it's not fattening the library too much.

[jackburridge]

Yes this is me! Just to assuage any doubts

[macfreek]

Hi Jack, I should have recognized that! :) Happens if I don't pay close enough attention. My response was meant as an encoureagement to contribute, but also signifying that I may not have the time at the moment to work on it myself.

Since you are obviously using restbuilder for a longer time, submit meaningful contribution and communicate well, I've just given you write access to this repository, if you are willing to accept that invite. (Edit: I send the invite to your personal account, let me know if you prefer to use the other account).