Skip to content

prokoudine/ardour-manual-sphinx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ardour user manual

This is a preliminary port of the Ardour manual to Sphinx.

Prerequisites

$ pip install sphinx sphinx-book-theme sphinxcontrib-video sphinx-multiversion

Building HTML

The following command builds an HTML version of the user manual:

$ make html

TODO

  • Pick an initial theme
  • Do the port (pandoc to convert + images)
  • Restructure the guide (parts of the Interface chapter belong to Editing and Mixing)
  • Fix all the broken references (clean rebuild shows them all)
  • Clean up formatting (replace :menuselection: and :guilabel: with bold text)
  • Set up CI (deployment, linting)
  • (Optional) Set up versioning so it's possible to switch between e.g. 8.12 and 9.0
  • Take care of redirects where possible

About

Port of the Ardour manual to Sphinx

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •