scaffold_documentation.py File Reference

Go to the source code of this file.

Namespaces
namespace	scaffold_documentation

Functions
str	scaffold_documentation.identifier_slug (str value)
	Build a safe Doxygen/file identifier from a free-form title.
str	scaffold_documentation.slug (str value)
	Anchor slug for a selector value.
int	scaffold_documentation.next_page_number ()
	Lowest unused page number in docs/pages.
str	scaffold_documentation.capability_entry (str family_id, str value)
	Render a Tier-2 capability entry carrying every required contract part.
str	scaffold_documentation.alias_stub (str family_id, str value, str canonical)
	Render a deprecated-alias stub, which owes three parts rather than eight.
str	scaffold_documentation.suggested_filename (str title, int number)
	Filename for a scaffolded page, using the same sanitized identifier as the page ID.
str	scaffold_documentation.page (str kind, str title, int number)
	Render a page skeleton shaped to its document type's contract.
str	scaffold_documentation.subsystem_record (str identifier, str title)
	Render the machine-readable lifecycle record a planned subsystem owes.
str	scaffold_documentation.subsystem_charter (str identifier, str title)
	Render a subsystem charter at the planned lifecycle stage.
int	scaffold_documentation.main ()
	Emit a documentation skeleton for the requested kind.

Variables
	scaffold_documentation.REPO_ROOT = Path(__file__).resolve().parents[2]
str	scaffold_documentation.PAGES_DIR = REPO_ROOT / "docs" / "pages"
str	scaffold_documentation.FAMILIES_PATH = REPO_ROOT / "tests" / "tooling" / "capability_families.json"
dict	scaffold_documentation.PAGE_TYPES
str	scaffold_documentation.INCOMPLETE_MARKER = "@par SCAFFOLD-INCOMPLETE"
tuple	scaffold_documentation.INCOMPLETE_NOTE
dict	scaffold_documentation.PAGE_SECTIONS