cs24/sf-docs

Documentation repository for the SysFlow project

SysFlow Documentation

This repository aggregates the documentation from the different SysFlow projects and hosts SysFlow's issue tracker.

Online documentation

SysFlow documentation is automatically built on pushes and is available at sysflow.readthedocs.io.

Offline build

This documentation depends on Sphinx (http://www.sphinx-doc.org/en/master/), which must be installed to do builds. The project also requires the following Sphinx plugins:

• http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
• https://pypi.org/project/m2r/

To build the site as HTML go to the base directory and type:

make html