Building the Documentation

PyCCAPT documentation is built with Sphinx.

Prerequisites

From the repository root, install documentation dependencies:

pip install -r docs/requirements.txt

cd docs pip install -r requirements.txt

## Create rst files

If there is no conf.py file, create one with `sphinx-quickstart`.

## Build HTML (Recommended)

From the repository root:

```bash
sphinx-build -b html docs docs/_build/html

Open the generated entry point:

docs/_build/html/index.html

Build via make Helpers

If you prefer make scripts, run from the docs/ directory:

cd docs
make clean
make html

On Windows, use:

cd docs
.\make.bat clean
.\make.bat html

Regenerate API Stubs (When Needed)

Regenerate API .rst files only when package/module structure changes:

cd docs
sphinx-apidoc -o . ../pyccapt