lrn86 / documentation

The official documentation for coala

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

https://cloud.githubusercontent.com/assets/7521600/15992701/ef245fd4-30ef-11e6-992d-275c5ca7c3a0.jpg

The official documentation for coala

This is the official documentation for coala. The coala repository can be found here.

How to build

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 _buildhtmlindex.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 http://www.sphinx-doc.org/en/stable/markup/toctree.html#toctree-directive for an explanation of the syntax.

About

The official documentation for coala

License:GNU Affero General Public License v3.0


Languages

Language:Python 38.2%Language:Makefile 31.8%Language:Batchfile 30.0%