Skip to content

consra/documentation

This branch is 106 commits behind coala/documentation:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

f5d7f9a · Dec 17, 2016
Dec 12, 2016
Dec 17, 2016
Nov 12, 2016
Oct 18, 2016
Oct 10, 2016
Aug 17, 2016
Mar 24, 2016
Aug 23, 2016
Oct 18, 2016
Oct 30, 2016
Aug 18, 2016
Dec 4, 2016
Aug 17, 2016

Repository files navigation

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, and it is online at https://docs.coala.io. 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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 38.6%
  • Makefile 31.1%
  • Batchfile 29.4%
  • CSS 0.9%