Documentation

As is common in most Python projects:

• Markup is written in reStructuredText (and Sphinx)
• Output is generated using the Sphinx builder.

Generating

make docs

The command above builds the documentation in HTML. Multiple format-generations are supported: html, man (man-page) and text.

To generate docs in any format:

make -C docs/ <format>

Viewing

To view generated with the steps above , use one of the examples below:

• text documentation (for admins):

  less ./docs/build/text/index.txt
  

• man page (for developers):

  man -l ./docs/build/man/azanium.1
  

• HTML user documentation

  python -m webbrowser ./docs/build/html/index.html
  

Distributing

This documentation is automatically deployed to github-pages when a release is made (push and/or tag made on the master branch), via a zest.releaser entry-point.