Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Add the sphinx documentation generator to the documentation we already have #2343
I thought it might be nice to have a browsable (and printable) version of the documentation in an easy to find place. Since we already have quite some documentation in markdown, I decided to give sphinx a shot. It's a documentation generator that is popular with the python community, and is not to be confused with the onion routing packet protocol
This PR just puts all the pieces in place for sphinx to generate the rendered documents as HTML and PDF.
The resulting documentation is automatically built and published on every commit to
I tried asciidoctor https://gist.github.com/cheungnj/38becf045654119f96c87db829f1be8e and https://github.com/mle86/man-to-md.git but the result looks bad, maybe should rewrite all asciidoc files to markdown, then create manpage with pandoc, but it change too much.…
On Fri, Feb 15, 2019 at 6:48 AM Christian Decker ***@***.***> wrote: I was looking at how we can include asciidoc document in there, but couldn't find a converter yet. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <064fde1#commitcomment-32326199>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAhBil9HZrbQsYhv5TJjOho4UOl8mrfsks5vNeepgaJpZM4a6ruc> .