Document every repo in Sphinx, catalog PDFs, and verae-ops
Some checks are pending
offline / test (push) Waiting to run
Some checks are pending
offline / test (push) Waiting to run
Add missing package READMEs, expand Sphinx to all runtime modules, publish a LaTeX/PDF README book, and add verae-ops for Docker, Proxmox, VMs, dedicated hardware, and service linking. Catalog defaults to public PDF links for each module README and samples.
This commit is contained in:
parent
5ad3222def
commit
e401635fd6
222 changed files with 4498 additions and 123 deletions
|
|
@ -23,6 +23,7 @@ SECTIONS = [
|
|||
[
|
||||
("packages/overview/README.md", "System overview (plain language)"),
|
||||
("packages/overview/INDEX.md", "Documentation index"),
|
||||
("packages/verae-ops/README.md", "Install & maintenance (Docker, Proxmox, VMs, metal)"),
|
||||
("packages/verae-fleet/docs/CONSOLE.md", "Operator console (Fleet · Trace · Docs)"),
|
||||
("README.md", "Workspace README"),
|
||||
("docs/04-activate/SETUP-ZAPIER-DEVELOPER.pdf", "Zapier developer setup (PDF)"),
|
||||
|
|
@ -48,6 +49,48 @@ SECTIONS = [
|
|||
("packages/overview/08-diagrams.md", "Architectural diagrams"),
|
||||
],
|
||||
),
|
||||
(
|
||||
"Per-module README (public PDFs)",
|
||||
[
|
||||
("packages/overview/README.md", "overview"),
|
||||
("packages/verae-ops/README.md", "verae-ops (install)"),
|
||||
("packages/zappier/README.md", "zappier-edge"),
|
||||
("packages/verae-zapier-middleware/README.md", "verae-middleware"),
|
||||
("packages/verae-zapier/README.md", "verae-zapier-app"),
|
||||
("packages/verae-activate/README.md", "verae-activate"),
|
||||
("packages/verae-request-splitter/README.md", "verae-request-splitter"),
|
||||
("packages/verae-archive-worm/README.md", "verae-archive-worm"),
|
||||
("packages/verae-archive-aggregator/README.md", "verae-archive-aggregator"),
|
||||
("packages/verae-tree-node/README.md", "verae-tree-node"),
|
||||
("packages/verae-fleet/README.md", "verae-fleet"),
|
||||
("packages/verae-zapier-simulator/README.md", "verae-zapier-simulator"),
|
||||
("packages/zapier-user-docs/README.md", "zapier-user-docs"),
|
||||
("packages/docs-master/README.md", "zapier-docs-master"),
|
||||
("packages/verae-nats-process/README.md", "verae-nats-process"),
|
||||
],
|
||||
),
|
||||
(
|
||||
"Install / run",
|
||||
[
|
||||
("packages/verae-ops/README.md", "Ops index"),
|
||||
("packages/verae-ops/01-dependencies.md", "Dependencies and data flow"),
|
||||
("packages/verae-ops/02-docker.md", "Docker Compose"),
|
||||
("packages/verae-ops/03-proxmox.md", "Proxmox LXC / QEMU"),
|
||||
("packages/verae-ops/04-virtual-servers.md", "Virtual servers"),
|
||||
("packages/verae-ops/05-dedicated-hardware.md", "Dedicated hardware"),
|
||||
("packages/verae-ops/06-linking-services.md", "Linking dependent services"),
|
||||
("packages/verae-ops/07-maintenance.md", "Maintenance"),
|
||||
],
|
||||
),
|
||||
(
|
||||
"Samples",
|
||||
[
|
||||
("packages/zappier/zapier-app/README.md", "Sample Zapier app (metered zappier API)"),
|
||||
("packages/verae-activate/README.md", "Activate-now Add Numbers sample"),
|
||||
("packages/verae-zapier-simulator/README.md", "Hop-trace simulator"),
|
||||
("packages/verae-nats-process/README.md", "New NATS address template"),
|
||||
],
|
||||
),
|
||||
(
|
||||
"User guide (signup → lookup)",
|
||||
[
|
||||
|
|
@ -260,6 +303,9 @@ def main() -> None:
|
|||
sphinx = ROOT / "docs" / "sphinx" / "_build" / "html"
|
||||
if sphinx.exists():
|
||||
copy_tree(sphinx, SITE / "sphinx")
|
||||
latex_pdf = ROOT / "docs" / "sphinx" / "_build" / "latex" / "verae-zapier-modules.pdf"
|
||||
if latex_pdf.exists():
|
||||
copy_tree(latex_pdf, SITE / "sphinx" / "verae-zapier-modules.pdf")
|
||||
for pkg in (
|
||||
"verae-activate",
|
||||
"verae-zapier",
|
||||
|
|
@ -275,9 +321,10 @@ def main() -> None:
|
|||
"overview",
|
||||
"verae-nats-process",
|
||||
"docs-master",
|
||||
"verae-ops",
|
||||
):
|
||||
pkg_root = ROOT / "packages" / pkg
|
||||
if pkg in {"zapier-user-docs", "overview", "docs-master"}:
|
||||
if pkg in {"zapier-user-docs", "overview", "docs-master", "verae-ops"}:
|
||||
copy_tree(
|
||||
pkg_root,
|
||||
SITE / "packages" / pkg,
|
||||
|
|
@ -297,9 +344,13 @@ def main() -> None:
|
|||
for p in pkg_root.glob("*.md"):
|
||||
copy_tree(p, SITE / "packages" / pkg / p.name)
|
||||
else:
|
||||
readme = pkg_root / "README.md"
|
||||
if readme.exists():
|
||||
copy_tree(readme, SITE / "packages" / pkg / "README.md")
|
||||
for name in ("README.md", "SUMMARY.md", "NATS.md"):
|
||||
p = pkg_root / name
|
||||
if p.exists():
|
||||
copy_tree(p, SITE / "packages" / pkg / name)
|
||||
zap_app = ROOT / "packages" / "zappier" / "zapier-app" / "README.md"
|
||||
if zap_app.exists():
|
||||
copy_tree(zap_app, SITE / "packages" / "zappier" / "zapier-app" / "README.md")
|
||||
zdocs = ROOT / "packages" / "zappier" / "docs"
|
||||
if zdocs.exists():
|
||||
copy_tree(
|
||||
|
|
@ -428,6 +479,7 @@ def main() -> None:
|
|||
("verae-fleet", "Service catalog, replica floors, monitor"),
|
||||
("overview", "High-level system overview"),
|
||||
("verae-nats-process", "Template for a new NATS address"),
|
||||
("verae-ops", "Install, Docker, Proxmox, VMs, dedicated hardware"),
|
||||
]
|
||||
git_lis = "".join(
|
||||
f'<li><a href="https://git.georgelambert.org/marchon/{name}">{name}</a> '
|
||||
|
|
@ -447,6 +499,7 @@ def main() -> None:
|
|||
("docs/modules-pdf/", "Module PDFs (book)"),
|
||||
("docs/models-pdf/", "Model PDFs (book)"),
|
||||
("sphinx/index.html", "Sphinx HTML"),
|
||||
("sphinx/verae-zapier-modules.pdf", "Sphinx LaTeX PDF"),
|
||||
]
|
||||
extra_md = [
|
||||
("docs-master/README.html", "Master summaries (docs-master)"),
|
||||
|
|
@ -460,6 +513,7 @@ def main() -> None:
|
|||
("docs/modules/", "All module markdown"),
|
||||
("docs/models/", "All model markdown"),
|
||||
("sphinx/index.html", "Sphinx HTML"),
|
||||
("sphinx/verae-zapier-modules.pdf", "Sphinx LaTeX PDF"),
|
||||
]
|
||||
|
||||
def extra_section(items: list[tuple[str, str]]) -> str:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue