Contributing to the Docs¶
Reference for contributing to this documentation.
Quick start¶
- Set up Python virtual environment that includes docs-related dependencies.
uv sync --group docs
- Start the MkDocs development server.
uv run --no-sync mkdocs serve -f docs/mkdocs.yml
The MkDocs development server will be accessible at:
http://localhost:8000
. It will have live reloading enabled. You can pressCtrl+C
to terminate the server.
- (Optional) Build the MkDocs website.
uv run --no-sync mkdocs build -f docs/mkdocs.yml
File tree¶
docs/
content/ # Documentation source files (e.g. `.md`, `.ipynb`).
index.md # The documentation homepage.
nb/ # Jupyter notebooks (`.ipynb`).
...
mkdocs_overrides/ # Files that override default parts of the theme.
...
mkdocs.yml # The MkDocs configuration file.