Documentation

SoCo has Sphinx-based documentation, located in the doc subdirectory.

In addition to the Python packages in the requirements-dev.txt file, the Graphviz package must be installed on your platform to generate some of the images.

To generate the output files, cd into the doc directory and run make html. Running make without a target gives you a list of available formats (such as epub, latex, pdf, man pages, etc).

If you want to help with extending the documentation, have a look at Quick reStructuredText and Sphinx documentation contents.

The documentation is also automatically published on-line at Read the Docs.