mkdocs-terok
Shared ProperDocs documentation generators for terok projects.
Provides reusable modules for generating CI workflow maps, integration test maps,
module maps, code metrics reports, API reference pages, and config reference
documentation from Pydantic models. A built-in terok ProperDocs plugin drives
every generator except the config reference (which needs a consumer-supplied
Pydantic model); the generator modules themselves never import the doc engine and
can also be used standalone via mkdocs-gen-files shims.
The metrics 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.
Installation
Add to your project as a docs-build dependency.
pip:
pip install mkdocs-terok
uv — pyproject.toml (PEP 735 dependency group):
[dependency-groups]
docs = [
"mkdocs-terok~=0.8.0",
]
Configuration
Configured via the terok plugin in your properdocs.yml. See this
repository's own properdocs.yml for a self-documenting
example that exercises most of the generators the package ships.
License
0BSD — use freely, no strings attached.
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-terok 0.8.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_terok-0.8.1.tar.gz | 135.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_terok-0.8.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 178.0 kB
Release files / mkdocs_terok-0.8.1.tar.gz
| Download URL | mkdocs_terok-0.8.1.tar.gz |
|---|---|
| Size | 135.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e155d9a5dae219adb185046baf36d953085176602cda4ffcf4c95613ad1b8d91
|
|
BLAKE2b-256 checksum How to use checksums |
aec040608964662ad924267e8077f5b1f398ae536581b78f199a6e5644f05e2b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 19, 2026.
Transparency logRelease files / mkdocs_terok-0.8.1-py3-none-any.whl
| Download URL | mkdocs_terok-0.8.1-py3-none-any.whl |
|---|---|
| Size | 42.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
760ef69851b828b492bca44d50ec806eab03a1bfa5ea311c28b61bbefdf8a47d
|
|
BLAKE2b-256 checksum How to use checksums |
ac9ef588881212d1c21516cca34ba28069ff22c27c926503c30a56709f5c9fad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 19, 2026.
Transparency log
