Skip to content

ManthanKeim/documentation

This branch is 1 commit ahead of, 13 commits behind coala/documentation:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5a145ed · Oct 15, 2018
Jul 3, 2018
Jul 10, 2018
Oct 14, 2018
Oct 12, 2018
Aug 25, 2017
Nov 9, 2017
Oct 11, 2018
Jul 20, 2018
Jul 31, 2017
Jul 3, 2018
Mar 24, 2016
Jul 3, 2018
Mar 10, 2018
Apr 6, 2018
Aug 1, 2017
Jul 3, 2018
Apr 19, 2018
Aug 17, 2016
Jul 20, 2018
Jul 3, 2018
Feb 24, 2018
Oct 15, 2018

Repository files navigation

https://cloud.githubusercontent.com/assets/5716520/24838296/a9cf5f04-1d45-11e7-855c-47b816ce1e09.png

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

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 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 34.2%
  • Makefile 27.3%
  • Batchfile 25.9%
  • CSS 9.4%
  • HTML 2.6%
  • Shell 0.6%