raptor.conformance.doc_includes.scan_docs

Contents

raptor.conformance.doc_includes.scan_docs#

raptor.conformance.doc_includes.scan_docs(docs_root)[source]#

Scan every .rst/.md file under docs_root (excluding _build/) for include/literalinclude directives, resolving each with resolve_target(). One filesystem walk produces both the total directive count and the broken subset (see DocsScanReport).

Return type:: DocsScanReport