Writing RDFLib Documentation

These docs are generated with Zensical.

• When writing doc-strings use markdown and google style.
• API Docs are automatically generated with mkdocstring.
• See the supported admonitions here

Building

To build the documentation you can use zensical from within the uv environment. To do this, run the following commands:

# Install the docs dependencies
uv sync --group docs

# Build the docs
uv run python docs/gen_ref_pages.py
uv run zensical build

Built HTML docs will be generated in site/ and API documentation, generated as Markdown from doc-strings, will be placed in docs/apidocs/.

API Docs are automatically generated with mkdocstring

There is also a tox environment for building documentation:

tox -e docs

You can check the built documentation with:

npx -p live-server live-server site/

Development

Run development server with auto-reload on change to code:

uv run python docs/gen_ref_pages.py
uv run zensical serve

Tables

The tables in plugin_*.rst were generated with plugintable.py