Skip to content

Index

doc_gate

Documentation-gate schema surface.

Re-exports the public documentation-gate finding types.

DocGateFinding

Bases: BaseModel

A single finding emitted by the documentation gate.

Records the kind of issue, the referenced target, and the page on which the reference was found. Rejects unknown extra fields (extra='forbid').

Source code in packages/axm-audit/src/axm_audit/doc_gate/findings.py
Python
23
24
25
26
27
28
29
30
31
32
33
34
class DocGateFinding(BaseModel):  # type: ignore[explicit-any]
    """A single finding emitted by the documentation gate.

    Records the kind of issue, the referenced target, and the page on which
    the reference was found. Rejects unknown extra fields (``extra='forbid'``).
    """

    model_config = ConfigDict(extra="forbid")

    kind: FindingKind
    target: str
    source_page: str

FindingKind

Bases: StrEnum

Kinds of documentation-gate findings.

A StrEnum whose members compare equal to their string value, e.g. FindingKind.dead_link == "dead_link".

Source code in packages/axm-audit/src/axm_audit/doc_gate/findings.py
Python
10
11
12
13
14
15
16
17
18
19
20
class FindingKind(enum.StrEnum):
    """Kinds of documentation-gate findings.

    A ``StrEnum`` whose members compare equal to their string value, e.g.
    ``FindingKind.dead_link == "dead_link"``.
    """

    dead_link = "dead_link"
    missing_anchor = "missing_anchor"
    unknown_extension = "unknown_extension"
    bad_reference = "bad_reference"