https://github.com/coala/documentation
The official documentation for coala
https://github.com/coala/documentation
sphinx-documentation user-documentation
Last synced: 9 months ago
JSON representation
The official documentation for coala
- Host: GitHub
- URL: https://github.com/coala/documentation
- Owner: coala
- License: agpl-3.0
- Created: 2016-03-24T22:39:09.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2021-07-02T21:51:15.000Z (almost 5 years ago)
- Last Synced: 2025-08-21T21:39:48.514Z (10 months ago)
- Topics: sphinx-documentation, user-documentation
- Language: Python
- Homepage: http://docs.coala.io/
- Size: 628 KB
- Stars: 40
- Watchers: 11
- Forks: 177
- Open Issues: 66
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. image:: https://cloud.githubusercontent.com/assets/5716520/24838296/a9cf5f04-1d45-11e7-855c-47b816ce1e09.png
:target: https://coala.io/
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.