Python Tool Index¶

← LaTeX router · Documentation · Test catalogue

This index identifies each top-level source file in latex/tools/ and routes to the guide that owns its instructions. It does not duplicate command references or workflow policies.

Files¶

File	Responsibility and scoped reference
`build.py`	Document discovery, selection, compilation, and generated README/fixture checks. Build-system reference.
`build_docs.py`	Public-site staging, link adaptation, readers, and rendered validation. Documentation-site guide.
`check_repository.py`	Read-only structural, source-hygiene, Markdown, and tracked-PDF checks. Repository validation.
`create_course.py`	Metadata validation and localized course scaffolding. Course-creation guide.
`generate_changelog.py`	Per-course committed histories and changelog baselines. Changelog workflow.
`latex_source.py`	Import-only helpers that detect escaping and strip unescaped LaTeX comments while preserving line boundaries. It neither interprets TeX nor writes files.
`package_notes.py`	Deterministic release assets from existing compiled course PDFs. Packaging reference and staging ownership.
`run_tool_tests.py`	Coverage-enforced test entry point; saves Coverage.py data, normally as `.coverage` in the working directory. Test commands and coverage contract.
`update_release_catalog.py`	Updates the generated README catalogue and release archive from prepared release JSON. Release-catalogue workflow.
`TOOLS.md`	This manually maintained file index.

The test/ directory owns the test catalogue. Local __pycache__/ directories are disposable interpreter caches, not additional tools.

Running the tools¶

Task	Instructions
Install host prerequisites and validation dependencies	Installation
Compile documents and inspect generated output	Building documents
Create a course	Creating a course
Run repository checks	Local quality checks
Run all tests or a focused method	Running tests
Build or preview the website	Build and review locally
Package or publish an edition	Packaging · Publication authorization and workflow

Consult the scoped reference before running a generation tool: some commands replace protected outputs or clean owned staging directories. The physical tool/test layout is documented in LATEX.md.