![https://cloud.githubusercontent.com/assets/5716520/24838296/a9cf5f04-1d45-11e7-855c-47b816ce1e09.png](https://cloud.githubusercontent.com/assets/5716520/24838296/a9cf5f04-1d45-11e7-855c-47b816ce1e09.png)
This is the official documentation for coala, and it is online at https://docs.coala.io. The coala repository can be found here.
Install virtualenv
if you don't have it yet:
pip3 install virtualenvwrapper
Create a new virtualenv
and activate it:
virtualenv -p python3 coala-venv source coala-venv/bin/activate
And then run this command before trying to build the documentation:
pip3 install -r 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.
If you want to add new pages, you need to alter the index.rst file in the root directory. Please read https://www.sphinx-doc.org/en/stable/markup/toctree.html#toctree-directive for an explanation of the syntax.