audit_docs_site.py File Reference

Go to the source code of this file.

Namespaces
namespace	audit_docs_site

Functions
dict	audit_docs_site.load_contract ()
	Load the published-site integrity contract.
list[Path]|None	audit_docs_site.git_tracked_files ()
	List tracked plus non-ignored untracked files, so the scan set is reproducible for a commit and generated scratch is excluded without excluding tracked docs.
	audit_docs_site.iter_scannable ()
	Yield repository files whose text may carry project-owned URLs.
Path	audit_docs_site.require_built_html (dict contract)
	Resolve the generated HTML tree, failing loudly when it has not been built.
list[str]	audit_docs_site.check_forbidden_urls (dict contract)
	Reject project-owned URL forms that are known not to resolve.
list[str]	audit_docs_site.check_canonical_urls (dict contract, Path html_dir)
	Verify every canonical documentation URL names a page the build actually generates.
list[str]	audit_docs_site.check_layout (dict contract, Path html_dir)
	Verify every Doxygen layout tab resolves to a generated page.
list[str]	audit_docs_site.check_orphan_pages (dict contract, Path html_dir)
	Verify every page the build publishes is reachable from the navigation.
list[str]	audit_docs_site.check_generated_fragment_links (Path html_dir)
	Verify every link emitted by a generated fragment resolves in the rendered page.
str	audit_docs_site.strip_non_prose (str text)
	Blank out fenced code, inline code, and HTML comments.
list	audit_docs_site.markdown_fragment_links (str text)
	Extract Markdown links carrying a fragment, from prose only.
list	audit_docs_site.tracked_markdown ()
	Every Markdown file the current commit carries.
set	audit_docs_site.rendered_ids (Path path)
	Anchor ids present in a rendered HTML page.
str	audit_docs_site.heading_anchor (str text)
	GitHub-style anchor slug for a Markdown heading.
set	audit_docs_site.markdown_anchors (Path path)
	Anchors a plain Markdown file offers.
list[str]	audit_docs_site.check_page_cross_references (Path html_dir)
	Verify hand-written Markdown fragment links resolve, repository-wide.
int	audit_docs_site.main ()
	Fail when a project-owned URL is dead or a navigation tab has no generated page.

Variables
	audit_docs_site.REPO_ROOT = Path(__file__).resolve().parents[2]
str	audit_docs_site.CONTRACT_PATH = REPO_ROOT / "tests" / "tooling" / "docs_site_contract.json"
dict	audit_docs_site.SKIP_DIRS = {".git", "docs_build", "obj", "bin", "stubs", "runs", "studies", "__pycache__", ".pytest_cache"}
dict	audit_docs_site.SCAN_SUFFIXES = {".md", ".js", ".xml", ".html", ".yml", ".yaml"}