Docs creation

In order to build the docs you need to

1. install sphinx and additional support packages

2. build the package reference files

3. run sphinx to create a local html version

The documentation is build using readthedocs automatically.

Install the docs dependencies of the package (as speciefied in toml):

# in main folder
pip install .[docs]

Updating LLM documentation files

The API reference in docs/markdown_ref is updated automatically by the CI workflow. If you need to regenerate these files locally, or if the automation is unavailable for your branch, run the following commands manually:

# we are only interested in the reference files
sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../
sphinx-build -n -W --keep-going -b markdown ./ ./_build_markdown
mv _build_markdown/reference ./markdown_ref

Build docs using Sphinx command line tools

Command to be run from path/to/docs, i.e. from within the docs package folder:

Options:

• --separate to build separate pages for each (sub-)module

# pwd: docs
# apidoc
sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../src/acore
# download other resources
python fetch_files.py
# parse main repository README
python split_readme.py
# build docs
sphinx-build -n -W --keep-going -b html ./ ./_build/