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

Go to the source code of this file.

Namespaces

namespace  certify_documentation
 

Functions

None certify_documentation.run (list[str] command, str label)
 Run one certification gate and stream its output.
 
str certify_documentation.git_output (*str args)
 Return trimmed output from one Git command.
 
str certify_documentation.require_clean_revision ()
 Require that HEAD names a clean, commit-scoped source revision.
 
None certify_documentation.ensure_empty_doxygen_warning_log ()
 Fail certification when Doxygen reports a warning.
 
Path certify_documentation.write_certificate (str sha, bool runtime_checked)
 Write a reproducible certification record for one validated revision.
 
argparse.Namespace certify_documentation.parse_args (list[str] argv)
 Parse documentation-certification command-line arguments.
 
int certify_documentation.main (list[str]|None argv=None)
 Run the commit-scoped documentation certification workflow.
 

Variables

 certify_documentation.REPO_ROOT = Path(__file__).resolve().parents[2]