docs.md

📝 Docs

To build the documentation, run the following command:

# Install python documentation dependencies:
pip install -r ./requirements/requirements.docs.txt

# Serve documentation locally (for development):
mkdocs serve
# Or use the docs script:
./scripts/docs.sh

# Or build documentation:
mkdocs build
# Or use the docs script:
./scripts/docs.sh -b

Diagrams

Prerequisites:

• Install Graphviz

To generate diagrams, run the following command:

# Install python documentation dependencies:
pip install -r ./requirements/requirements.docs.txt

# Generate diagrams:
./scripts/diagrams.sh

MkDocs Material

Installation

# Install mkdocs-material and mkdocstrings:
pip install -U mkdocs-material mkdocstrings[python]

Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Docs layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

References

• MkDocs Documentation
• MkDocs Material Documentation
• mkdocstrings Documentation