Skip to content

Quality Gates

Run all checks before pushing:

1
2
3
4
5
.venv\Scripts\python.exe -m pytest
.venv\Scripts\python.exe -m ruff check docforge tests
.venv\Scripts\python.exe -m black --check docforge tests
.venv\Scripts\python.exe -m mypy docforge
.venv\Scripts\pydoclint.exe docforge

Test layout

Path Covers
tests/nav/ Nav spec, resolver, wiki nav
tests/cli/ Build command flows and modes
tests/renderers/ MkDocs / MCP rendering

CLI tests use the cli_runner fixture with mock_mkdocs_build and mock_mkdocs_load_config so they exercise the full flow without invoking a real MkDocs build.