Module

docs.checks

Contract checks for documentation integrity.

Registered byDocsPluginwhen mounted. Each check receives the ContractCheckSnapshot and appends issues to the CheckResult.

Checks:

  • check_docs_parseable — all .mdfiles in content_dir parse
  • check_docs_no_duplicate_slugs— no slug collisions
  • check_docs_cross_references — internal [text](slug)links resolve
  • check_docs_no_drafts_exposed— drafts excluded unless include_drafts
5Functions

Functions

_get_collection 1 ▼
Read the live collection from the holder stored in extras.
def _get_collection(snapshot: ContractCheckSnapshot)
Parameters
Name Type Description
snapshot ContractCheckSnapshot
check_docs_parseable 2 None ▼
Verify all ``.md`` files in the content directory are parseable.
def check_docs_parseable(snapshot: ContractCheckSnapshot, result: CheckResult) -> None
Parameters
Name Type Description
snapshot ContractCheckSnapshot
result CheckResult
check_docs_no_duplicate_slugs 2 None ▼
Detect duplicate slugs across markdown and autodoc pages.
def check_docs_no_duplicate_slugs(snapshot: ContractCheckSnapshot, result: CheckResult) -> None
Parameters
Name Type Description
snapshot ContractCheckSnapshot
result CheckResult
check_docs_cross_references 2 None ▼
Verify internal markdown links resolve to existing slugs.
def check_docs_cross_references(snapshot: ContractCheckSnapshot, result: CheckResult) -> None
Parameters
Name Type Description
snapshot ContractCheckSnapshot
result CheckResult
check_docs_no_drafts_exposed 2 None ▼
Warn if draft pages are included in the live collection.
def check_docs_no_drafts_exposed(snapshot: ContractCheckSnapshot, result: CheckResult) -> None
Parameters
Name Type Description
snapshot ContractCheckSnapshot
result CheckResult