Skip to content

Files

Latest commit

5a5d7c4 · Mar 25, 2022

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Mar 25, 2022
Jul 11, 2019
Jul 11, 2019

Documentation for timeserio

This directory contains the sources (.md and .rst files) for the documentation. The main index page is defined in source/index.rst. The Sphinx options and plugins are found in the source/conf.py file. The documentation is generated in full by calling make html which also automatically generates the Python API documentation from docstrings.

Building documentation locally

Dependencies must be installed using make sync from the project root. Run make docs-build from project root, or make html from the docs/ subfolder (this one).

Note this can take some time as some of the notebooks may be executed during the build process. The resulting documentation is located in the _build directory with _build/html/index.html marking the homepage.

Sphinx extensions and plugins

We use various Sphinx extensions and plugins to build the documentation:

The full list of plugins and their options can be found in source/conf.py.