Kur’s documentation is written in restructured text and built with Sphinx. Installing Sphinx is easy:
pip install sphinx
Install the Theme¶
To build the documentation, you need to install the Read the Docs Sphinx theme. To do this:
pip install sphinx_rtd_theme
Actually Building Everything¶
From the root of the repository, enter the documentation directory (
and then you can build the documentation with:
This will put the root HTML page at
docs/build/html/index.html relative to
the root of the repository.
You don’t need to install Kur or its dependencies to build the documentation.