mkdocs-terok 0.6.0

Shared ProperDocs documentation generators for terok projects

mkdocs-terok

Shared ProperDocs documentation generators for terok projects.

Provides reusable modules for generating CI workflow maps, integration test maps, code quality reports, API reference pages, and config reference documentation from Pydantic models. A built-in terok ProperDocs plugin drives all generators automatically; the generator modules themselves never import the doc engine and can also be used standalone via mkdocs-gen-files shims.

The quality report module can optionally parse output from scc, complexipy, tach, vulture, and docstr-coverage. When any of these tools is absent, the corresponding report section degrades gracefully to a warning admonition.

Installation

Add to your project's pyproject.toml as a docs-build dependency:

[tool.poetry.group.docs.dependencies]
mkdocs-terok = "^0.5"

License

0BSD — use freely, no strings attached.