doalitic/brook-docs repository overview

⁠Documentation for Brook.io

This project hosts the source behind brook.io/docs⁠.

The documentation is written using reStructuredText files which are located under the source/ directory. They are compiled into html documents using Sphinx⁠.

In order to generate the documentation, just run make html from the root of the repository. The corresponding output must be placed under the build/html/ directory.

Sphinx and the employed theme from Read the Docs are installed within a Docker container by means of pip install Sphinx sphinx_rtd_theme. The /var/www/docs/ directory is exported as a volume so that it can be used from an outside container, mainly from a web server.