Generating Documentation

There is an html manual associated with each of the command-line programs. This documentation partially relies on a system that is shared with other wrappers of the Fluid Corpus Manipulation Project for different creative coding environments.

Pre-requisites:

• Python 3
• Docutils python package (ReST parsing)
• Jinja python package (template engine)
• PyYAML >= 5.1 (YAML parsing)

To generate html documentation for the executables requires a further dependency, flucoma-docs, which we use to combine generated and human-written docs. We then pass DOCS=ON to CMake

cmake -DDOCS=ON ..

Unless we pass the location on disk of flucoma-docs, CMake will again take care of downloading this dependency.

This process:

• has only ever been tested on Mac, so may well not work at all on Windows
• can sometimes produce spurious warnings in Xcode, but should work