Skip to content

# Writing RDFLib Documentation

These docs are generated with Material for MkDocs.

- 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 `mkdocs` from within the poetry environment. To do this, run the following commands:

    # Install poetry venv
    poetry install

    # Build the docs
    poetry run mkdocs 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:

    poetry run mkdocs serve

## Tables

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