Documentation Structure

The RDMC Prototype documentation is built using Sphinx and is organized into separate folders per release version. The latest version is 0.6.0.

Folder Structure

Each release has its own dedicated documentation folder under the docs/ directory:

docs/
├── 0.2.0/
├── 0.3.0/
├── 0.4.0/
├── 0.5.0/
└── 0.6.0/       ← latest version
    ├── source/
    └── build/

Setting Up the Environment

Before building the documentation, activate your virtual environment and install all required dependencies.

Activate the virtual environment:

venv\Scripts\Activate

or:

.venv\Scripts\Activate

Install all required libraries:

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

Building the Documentation

Build the HTML documentation:

cd docs/0.6.0
make html

Clean and rebuild (use this if changes are not reflecting):

rmdir /s /q build\doctrees && make html

The generated HTML files will be available at:

docs/0.6.0/build/html/index.html

Previous Versions

Documentation for all previous releases is available and can be accessed via the Versions page. Each version is independently built and stored in its own folder.