Verae Compound Documentation

Aggregates documentation from all VeraeLLC git repositories into a single compound document with API references, cross-references, and LaTeX output.

Quick Start

# Generate everything (HTML + LaTeX)
make docs

# Or run directly
bash scripts/build.sh

Output

• output/html/ — Browsable HTML documentation
• output/latex/VeraeLLC-Systems-Documentation.tex — LaTeX source
• output/metadata.json — Build statistics

Structure

verae-docs/
├── scripts/
│   ├── build.sh                    # Shell entrypoint
│   ├── generate-compound-docs.py   # Main orchestrator
│   ├── parsers/                    # Language parsers
│   │   ├── go_parser.py
│   │   ├── python_parser.py
│   │   ├── rust_parser.py
│   │   ├── js_parser.py
│   │   └── shell_parser.py
│   ├── cross_ref.py                # Cross-reference builder
│   └── rst_generator.py            # RST/LaTeX generator
├── docs/                           # Generated Sphinx source
├── output/                         # Generated HTML + LaTeX
└── requirements.txt

Features

• Multi-language parsing: Go, Python, Rust, JavaScript/TypeScript, Shell
• Public/Private API separation: Public functions sorted alphabetically; private grouped by module
• Data structure index: All structs, classes, enums, interfaces, traits
• Cross-reference guide: Caller/callee relationships, inter-repo dependencies, external libraries
• LaTeX output: Single .tex file suitable for PDF generation