epythet.validationΒΆ
epythet validate: tiered documentation validation with a growing artifact ledger.
Levels 0 (lint and coverage), 0.5 (parse), 1 (build), 2 (render) and 3
(review packet) live here. The ledger of known rendering artifacts is under
epythet/ledger/rules (one YAML per rule with a sibling .py fixture);
observations from real runs are appended outside the repository, and rules a
reviewer proposes go to an overlay there too (epythet ledger propose).
>>> from epythet.validation import validate
>>> report = validate("path/to/project", level=1)
>>> report.exit_code()
0
Modules
Level 1: run the documentation build and turn its warning stream into findings. |
|
The |
|
The |
|
Level 0 coverage and quality smells: the queue signals, computed from the |
|
Named doctree detectors, referenced from ledger rules by |
|
Docstring extraction from Python source, without importing anything. |
|
Level 0: static docstring linters, normalised into the finding model. |
|
The finding and report model shared by every level of |
|
Level 0.5: parse each docstring's docutils doctree and run the ledger's detectors. |
|
|
Write every |
|
Render with the named format ( |
Level 2: read the rendered output (XML, HTML, text) and report what the build hid. |
|
Level 3: a review packet for an in-session agent, and the ingestion of its reply. |