Documentation project for NucleusIQ, built with MkDocs and Material for MkDocs. Dependencies are declared in pyproject.toml and locked with Poetry (poetry.lock).

• Python 3.10+
• Poetry (recommended), or use pip install poetry inside your environment

python -m venv .venv

Windows (PowerShell):

.venv\Scripts\Activate.ps1

macOS/Linux:

source .venv/bin/activate

From the repository root:

poetry install --no-interaction

This installs MkDocs and related packages from the lockfile into Poetry’s virtualenv.

Without Poetry: you can install the same toolchain with pip (PEP 517) if needed:

pip install .

poetry run python scripts/check_docs.py
poetry run python -m mkdocs build --strict

poetry run python -m mkdocs serve

Open: http://127.0.0.1:8000/nucleusiq-docs/

If you used pip install . instead of Poetry, run the same commands without the poetry run prefix.