Alces Flight Appliance Documentation

Documentation to support deployment and usage of Alces Flight Appliances

• Read the documentation

Writing documentation

Assuming you have Python installed, install the dependencies by running the following:

pip install sphinx sphinx-autobuild sphinx_rtd_theme

You can then make your changes to the pages you want to edit; see here for a syntax reference.

To preview your changes:

cd docs
make html
xdg-open build/html/$file

where $file is the path to the file to view within the docs/source directory, with .html rather than .rst extension.