This document gives a short introduction on how to write documentation for the coala project.
To familiarize yourself with the reStructuredText syntax please see this guide.
If you want to add new pages, you need to alter the
in the root of the repository. Please read
for an explanation of the syntax.
You should run this command before trying to build the documentation:
pip3 install -r docs-requirements.txt
You can test the documentation locally through simply running
make html in the root directory. This generates
_build\html\index.html that you can view on your browser.