Proof of concept Sphinx PDF/HTML Ardour Manual

I’ve taken the PDF doc thing a step beyond my first attempt. I converted the single page HTML version of the manual to reStructuredText with Pandoc and then fed that into Sphinx. Sphinx can then go back out to HTML and Tex PDF, etc.

PDF: https://zrnsm.github.io/ardour-manual-sphinx/ardour.pdf
HTML: https://zrnsm.github.io/ardour-manual-sphinx/
Source: https://github.com/zrnsm/ardour-manual-sphinx

There’s a bunch of stuff that is obviously broken; this is just a proof of concept. Next step would be to take a pass through the reStructuredText to clean it up and maybe think about applying the existing HTML styling. Another idea would be to try to preserve the existing “pagination” in the translation to .rst; for simplicity I just started from the existing single page HTML version.

1 Like

How is this going? As the rookiest of the rookies over here, I am in bad need of this in order to flatten my learning curve… an offline, fully contained and portable version of the Ardour manual, would be highly convenient, I believe… when I once briefly did return to learning software development some decades ago, I had learned how to easily (as long as it was legally allowed) extract a PDF version of any complete online web page. I vaguely recall that this involved going through the W3C, if I’m not mistaken. But I totally forgot how. Any ideas, suggestions as to how to get to this, with proper authorization from Ardour, will be more than welcome.
Thanks a bunch.

The manual has since changed and these days one can directly create a PDF from the manual source (GitHub - Ardour/manual: Mirror of the Ardour manual) by running build.py --pdf

The layout is not perfect but reasonable. Here’s one that I created a few weeks ago:

3 Likes

Simply outstanding.
Thank you Dr Robin ! :slight_smile:
This is - without a doubt - gonna make my Ardour student life, way less arduous !
Stay blessed !

1 Like