8. Meta-Documentation¶
8.1. How to build and publish this documentation?¶
Nothing really. Currently this documentation is hosted on https://cogent.readthedocs.io/. Everything is carefully taken care of by Read The Docs. Just edit the source files and configuration files and everything should be automatic.
8.2. How to build this documentation locally?¶
- We use the Sphinx-rtd-theme from https://github.com/readthedocs/sphinx_rtd_theme.
The theme files are not included in this repository, so if you want to build the
html files, then follow the instructions here:
https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html.
Symblink or copy the directory
sphinx_rtd_theme/sphinx_rtd_theme
todocs-src/_themes/
. - Run
make html
or other target as desired.