This is the documentation for The Coral Project, and it is a work in progress. Please report any issues in Github.
You can view the Coral Project documentation at https://coralprojectdocs.herokuapp.com.
Documentation is build via mkdocs. To build the documentation:
- Verify that you have python and pip installed (version numbers may vary):
$ python --version Python 2.7.2 $ pip --version pip 1.5.2
If not follow these steps.
-
Install mkdocs:
pip install mkdocs
-
Build the documentation from the root directory of this repo.
mkdocs build
-
Push to master. This will trigger an update of docs.coralproject.net that will take about 10 minutes. See the docsync directory for details.