Metadata-Version: 2.4
Name: mkdocs-terok
Version: 0.5.6
Summary: Shared ProperDocs documentation generators for terok projects
License: 0BSD
License-File: LICENSE
License-File: LICENSES/0BSD.txt
Keywords: properdocs,mkdocs,documentation,quality-report,ci-map
Author: Jiri Vyskocil
Author-email: jiri@vyskocil.com
Maintainer: Jiri Vyskocil
Maintainer-email: jiri@vyskocil.com
Requires-Python: >=3.12,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Framework :: MkDocs
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Typing :: Typed
Requires-Dist: PyYAML (>=6.0)
Requires-Dist: properdocs (>=1.6.7)
Project-URL: Changelog, https://github.com/terok-ai/mkdocs-terok/releases
Project-URL: Documentation, https://terok-ai.github.io/mkdocs-terok/
Project-URL: Homepage, https://terok.ai/
Project-URL: Issues, https://github.com/terok-ai/mkdocs-terok/issues
Project-URL: Repository, https://github.com/terok-ai/mkdocs-terok
Project-URL: Security, https://github.com/terok-ai/mkdocs-terok/security/policy
Description-Content-Type: text/markdown

# mkdocs-terok

[![License: 0BSD](https://img.shields.io/badge/License-0BSD-green.svg)](https://opensource.org/license/0bsd)
[![REUSE](https://api.reuse.software/badge/github.com/terok-ai/mkdocs-terok)](https://api.reuse.software/info/github.com/terok-ai/mkdocs-terok)
[![codecov](https://codecov.io/gh/terok-ai/mkdocs-terok/graph/badge.svg)](https://codecov.io/gh/terok-ai/mkdocs-terok)

Shared [ProperDocs](https://properdocs.org/) 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](https://github.com/boyter/scc),
[complexipy](https://github.com/rohaquinern/complexipy),
[tach](https://github.com/gauge-sh/tach),
[vulture](https://github.com/jendrikseipp/vulture), and
[docstr-coverage](https://github.com/HunterMcGushion/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:

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

## License

[0BSD](https://opensource.org/license/0bsd) — use freely, no strings attached.

