Emukit uses Sphinx to build its documentation.
To install dependencies required to build docs, run this from the package root folder:
pip install -r requirements/doc_requirements.txt
Sphinx-apidoc is used to generate API reference source .rst files. If you are changing the structure of the modules or introducing new module, you need to re-generate these files. To do so, from inside the "doc" folder, run:
rm api/*
sphinx-apidoc -d 1 -E -o ./api ../emukit ../emukit/examples
Notice we exclude examples from documentation, as they have specific dependencies.
If you'd like to generate the docs locally, from inside the "doc" directory, run:
make html