PICurv 0.1.0
A Parallel Particle-In-Cell Solver for Curvilinear LES
 
Loading...
Searching...
No Matches
Namespaces | Functions | Variables
audit_page_types.py File Reference

Go to the source code of this file.

Namespaces

namespace  audit_page_types
 

Functions

dict audit_page_types.declared_pages ()
 Every @page id in the documentation sources, with its file.
 
str audit_page_types.inline_type (Path path)
 The page type a page declares inline, if any.
 
int audit_page_types.main ()
 Fail when a published page is untyped or its declarations disagree.
 

Variables

 audit_page_types.REPO_ROOT = Path(__file__).resolve().parents[2]
 
str audit_page_types.REGISTRY = REPO_ROOT / "tests" / "tooling" / "page_types.json"
 
str audit_page_types.HTML_DIR = REPO_ROOT / "docs_build" / "html"
 
tuple audit_page_types.PAGE_DIRS = ("docs/pages", "docs")
 
dict audit_page_types.PLACEHOLDER_IDS = {"<ID>", "<id>"}