Skip to content

Readthedocs and markdown manpages#2936

Merged
rustyrussell merged 8 commits into
ElementsProject:masterfrom
darosior:manpage_markdown
Aug 22, 2019
Merged

Readthedocs and markdown manpages#2936
rustyrussell merged 8 commits into
ElementsProject:masterfrom
darosior:manpage_markdown

Conversation

@darosior

@darosior darosior commented Aug 10, 2019

Copy link
Copy Markdown
Contributor

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

@rustyrussell

Copy link
Copy Markdown
Contributor

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...

@rustyrussell rustyrussell added this to the 0.7.3 milestone Aug 10, 2019
@darosior

darosior commented Aug 10, 2019

Copy link
Copy Markdown
Contributor Author

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.

It's already what's done ? 547b0c0 for txt replacement by md and eb09276 for manpage replacement

Someone has to read all the man pages though...

I've read most of them yesterday and will finish today once I've fixed some typos

@darosior darosior changed the title WIP: Another try for markdown manpages Readthedocs and markdown manpages Aug 10, 2019
@darosior

Copy link
Copy Markdown
Contributor Author

I've fixed the Markdown lists inconsistence at roff generation, regenerated manpages, adapted check-manpages, stole @rustyrussell's recipe to update readthedocs pages from #2928, and (more importantly) reviewed all generated md files and manpages.

@darosior

Copy link
Copy Markdown
Contributor Author

Here is another Markdown manpage sample : https://gist.github.com/darosior/05e6c9da8d2bb0f55b8c15ca217b6499 (took disconnect because there are multiple text formatting : code, errors, bold, italic, ..)
And here is the corresponding man :
disco_manpage

@cdecker

cdecker commented Aug 11, 2019

Copy link
Copy Markdown
Member

ACK e007a9f

@darosior

Copy link
Copy Markdown
Contributor Author

Rebased to resolve conflicts.

@cdecker

cdecker commented Aug 12, 2019

Copy link
Copy Markdown
Member

I'm afraid we missed the freeze window by a tiny bit, so we'll merge this directly after the 0.7.2.

@rustyrussell

Copy link
Copy Markdown
Contributor

Rebased, a bit tricky since listforards had been significantly reworked. but we have the whole dev window to fixup :)

Ack 4b9e3c9

@darosior

Copy link
Copy Markdown
Contributor Author

Thank you for the rebase! :-)

@rustyrussell rustyrussell merged commit 3d85154 into ElementsProject:master Aug 22, 2019
@darosior darosior mentioned this pull request Sep 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Integrate the man-pages into the generated docs webpage

3 participants