Readthedocs and markdown manpages#2936
Conversation
|
Yeah, happy with this. I grabbed asciidoc because I'd used it before for man pages; happy to change to any sane format, like another markdown. Would be tempted to split into one commit which replaced the .txt with .md files, and another which replaced the generated man pages. But that's a minor issue, to help review. Someone has to read all the man pages though... |
It's already what's done ? 547b0c0 for txt replacement by md and eb09276 for manpage replacement
I've read most of them yesterday and will finish today once I've fixed some typos |
bdb57b6 to
a987170
Compare
|
I've fixed the Markdown lists inconsistence at roff generation, regenerated manpages, adapted |
|
Here is another Markdown manpage sample : https://gist.github.com/darosior/05e6c9da8d2bb0f55b8c15ca217b6499 (took |
|
ACK e007a9f |
e007a9f to
fbf5186
Compare
|
Rebased to resolve conflicts. |
|
I'm afraid we missed the freeze window by a tiny bit, so we'll merge this directly after the 0.7.2. |
fbf5186 to
4b9e3c9
Compare
|
Rebased, a bit tricky since listforards had been significantly reworked. but we have the whole dev window to fixup :) Ack 4b9e3c9 |
|
Thank you for the rebase! :-) |

As per #2928 (comment), fixes #2918.
This completely moves on from asciidoc to Markdown for manpages thanks to a tweaked version of a Python Markdown->Roff converter. That way, manpages can be completely written in Markdown, displayed in readthedocs, and converted to Roff.
There are still some little things to be fixed with final Roff manpages (WIP) but I wanted to get some feedbacks (for example, is the huge number of insertions/deletions due to file creation/deletion/regeneration a problem ?). Here is a sample of a Markdown manpage : https://gist.github.com/darosior/48bfdf65017ad4a10811be5f00adc32d .
Closes #2928