README.md

Observability docs

This repo contains docs and scripts for building and deploying documentation for the Canonical Observability Stack.

Docs are published to readthedocs and are based on Canonical's Sphinx Starter Pack.

Build the docs

You must install python3-venv before you can build the documentation, for example

sudo apt install python3-venv

After installing the python3-venv package, (re)create your virtual environment.

rm -rf docs/.sphinx/venv
python3 -m venv docs/.sphinx/venv

and install sphinx dependencies:

cd docs
source .sphinx/venv/bin/activate
pip install -r requirements.txt

Build and serve the docs locally:

make serve

Run quality checks

cd docs
make spellcheck woke linkcheck