How to create a PDF version of the Ardour manual

Getting Stuff Done How do I .... ?
#1

Pops up every now and then. (maybe this should be in the FAQ?)

Description is here GitHub - Ardour/manual: Mirror of the Ardour manual · GitHub
It’s easy. Even I could do it (this is for Linux only!):

  1. You will need git, python3, and cherrypy and weasyprint python modules installed.
    Use your package manager to do that, if not already available.

    In a terminal on the command line do the following

  2. Download the manual source from github.com

     % git clone https://github.com/Ardour/manual ardour-manual

  3. Create the PDF:

       % cd ardour-manual
       % ./build.py -p

The manual is here:
./website/manual.pdf

Corrections kindly by:
@TonyBKDE
@Axel99092

6 Likes
#2

Thanks for this! Very nice and by the way extremely cool. Learned something.

You have single quotes around the git command in your post - found them a bit confusing as I saw the one at the end before spotting the one at the beginning. Also for me it was ./build**.py** -p

1 Like
#3

thanks for pointing this out. FIxed

1 Like
#4

thank you Peter,

This is a nice tip, and very usefull to be able to consult the Ardour.pdf manual when offline.
Kind Regards, Luc.

#5

should be

  % ./build.py -p
3 Likes
#6

Exactly that’s what I have in my command history :slight_smile:
Fixed

1 Like
#7

Hi
Thanks for this!

But, what about adding a link from Ardour itself - within its Help?

It seems strange the manual itself is not within Ardour in the first place, anyway - i understand it changes, but each version should have its manual internally - maybe as an option to download it.

Just a ‘obvious to me’ thought.

Thanks
[Hardour]

1 Like
#8

I think that would be very nice …

#9

Ardour does not have many people working on documentation, so there could be changes to the online documentation after the binary build is released. If the documentation snapshot were included with the binary then the most easily accessible documentation could be out of date, incomplete, or incorrect in some way.

1 Like