Maintain the documentation

The guides are Markdown files in docs/. The API pages use mkdocstrings to read signatures and docstrings from the package. Update the relevant guide or docstring when a public interface changes.

From the source checkout, build and check the site with:

python -m pip install -e '.[docs]'
python -m mkdocs build --strict
python -m mkdocs serve

The generated site is in site/. It is ignored by Git and is not part of the PyPI wheel. PyPI displays the root README.md as the package description.

Publish the documentation

The documentation is published at Codeberg Pages from the pages branch of the public repository. After changing the guides or API docstrings, build the site and replace the contents of the pages branch with the generated site/ files. Keep the source code on main; use a separate checkout or worktree for pages.

Check the published index and navigation after each update. If a future push to pages does not update the site, follow the current Codeberg Pages instructions for the webhook or Forgejo Actions deployment method.

Release checks

python -m mkdocs build --strict
python -m pip install build
python -m build

Inspect both the wheel and source archive before uploading them. The model weights and paper figures are distributed separately from the Python package.