Fortuna Documentation

The documentation for Fortuna can be found here.

Build the documentation

The documentation for Fortuna consists of a series of notebooks. To serve these locally, there are two steps that need to be taken that we outline below.

Prerequisites

To build the documentation, first install Fortuna and it's dependencies by following the installation instructions. Next, install the documentation requirements through

poetry install -E docs

Notebooks

For easier version control, the notebooks are stored as .pct.py files. To convert these to .ipynb files, run the following command from the root of the repository:

jupytext --to notebook examples/*pct.py

This will create a corresponding notebook file for each .pct.py file that can be opened in Jupyter.

Building the documentation

From the root directory, documentation can be built by running the following commands:

cd docs
poetry run make html

Documentation will then be available in the docs/build/html directory.

The above process can be slow as it executes each notebook one-by-one. To build the notebooks in parallel, run the following command:

cd docs
sphinx-build -b html -j auto source build/html

Additional Information

For VSCode users, we recommend installing the Jupytext extension to automatically render .pct.py as Jupyter notebooks when opened in VSCode.