Installation

Local Development Checkout

Install the package in editable mode from the repository root:

python -m pip install -e .

The base package includes the database loader, census views, validation command, LaTeX/table helpers, figure generation, PowerPoint slide generation, and bundled production data.

For development, curation staging from a source checkout, packaging checks, and verification work, install the contributor tools too:

python -m pip install -e ".[dev]"

For local documentation builds, install the documentation extra:

python -m pip install -e ".[docs]"

Both extras can be installed together:

python -m pip install -e ".[dev,docs]"

Documentation Build

Build the documentation locally with:

python -m sphinx -b html docs docs/_build/html

The generated HTML entry point is docs/_build/html/index.html.

Read the Docs

Read the Docs is configured through .readthedocs.yaml. The hosted build installs the project with the docs optional dependency group, equivalent to:

python -m pip install ".[docs]"