This repo is home to a Sphinx project
used to generate https://ocean-eddy-cpt.github.io.
It uses GitHub pages
to host the project documentation.
The source code for the documentation lives in the source branch.
The built html lives in the master branch.
We use doctr to build the documentation on
Travis CI.
This is configued in the .travis.yml file.
The documentation can be written in either markdown (.md) or
restructuredtext (.rst).
To edit or add to the documentation, make a pull-request to this repo.
# install the required packages
pip install -r requirements.txt
# build the docs
cd doc
make html
# preview the output
cd _build/html
python -m http.server