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
|
|
@ -15,6 +15,31 @@ PACKAGES = [
|
|||
("verae-zapier-middleware", ROOT / "packages" / "verae-zapier-middleware" / "src", (".js",)),
|
||||
("verae-activate", ROOT / "packages" / "verae-activate", (".js",)),
|
||||
("verae-zapier", ROOT / "packages" / "verae-zapier", (".js",)),
|
||||
("verae-fleet", ROOT / "packages" / "verae-fleet" / "src", (".js",)),
|
||||
("verae-tree-node", ROOT / "packages" / "verae-tree-node" / "src", (".js",)),
|
||||
("verae-archive-worm", ROOT / "packages" / "verae-archive-worm" / "src", (".js",)),
|
||||
("verae-archive-aggregator", ROOT / "packages" / "verae-archive-aggregator" / "src", (".js",)),
|
||||
("verae-request-splitter", ROOT / "packages" / "verae-request-splitter" / "src", (".js",)),
|
||||
("verae-nats-process", ROOT / "packages" / "verae-nats-process" / "src", (".js",)),
|
||||
("verae-zapier-simulator", ROOT / "packages" / "verae-zapier-simulator" / "src", (".js",)),
|
||||
]
|
||||
|
||||
REPO_READMES = [
|
||||
"overview",
|
||||
"verae-ops",
|
||||
"zappier",
|
||||
"verae-zapier-middleware",
|
||||
"verae-zapier",
|
||||
"verae-activate",
|
||||
"verae-request-splitter",
|
||||
"verae-archive-worm",
|
||||
"verae-archive-aggregator",
|
||||
"verae-tree-node",
|
||||
"verae-fleet",
|
||||
"verae-zapier-simulator",
|
||||
"zapier-user-docs",
|
||||
"docs-master",
|
||||
"verae-nats-process",
|
||||
]
|
||||
|
||||
SKIP_PARTS = {"test", "tests", "node_modules", "dist"}
|
||||
|
|
@ -296,7 +321,7 @@ def main() -> None:
|
|||
f"{rst_title}\n{'=' * len(rst_title)}\n\n"
|
||||
f"Generated API sheet for ``{rel}``.\n\n"
|
||||
f".. include:: {sibling_md.name}\n"
|
||||
f" :literal:\n",
|
||||
f" :parser: myst_parser.sphinx_\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
index_entries.append(rel)
|
||||
|
|
@ -308,18 +333,40 @@ def main() -> None:
|
|||
idx.append(f"- [{rel}]({rel}.md)")
|
||||
(OUT_MD / "README.md").write_text("\n".join(idx) + "\n", encoding="utf-8")
|
||||
|
||||
repos_dir = ROOT / "docs" / "sphinx" / "repos"
|
||||
repos_dir.mkdir(parents=True, exist_ok=True)
|
||||
repo_entries = []
|
||||
for name in REPO_READMES:
|
||||
src = ROOT / "packages" / name / "README.md"
|
||||
if not src.exists():
|
||||
continue
|
||||
dest = repos_dir / f"{name}.md"
|
||||
dest.write_text(src.read_text(encoding="utf-8"), encoding="utf-8")
|
||||
repo_entries.append(f"repos/{name}")
|
||||
|
||||
repo_toc = "\n ".join(repo_entries) or "repos/overview"
|
||||
toctree = "\n ".join(rst_entries)
|
||||
sphinx_index = f"""Verae × Zapier module reference
|
||||
=================================
|
||||
|
||||
Public HTML: https://zapier.georgelambert.org/sphinx/
|
||||
LaTeX/PDF: https://zapier.georgelambert.org/sphinx/verae-zapier-modules.pdf
|
||||
Markdown indexes: https://zapier.georgelambert.org/index-md.html
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Repository READMEs
|
||||
|
||||
{repo_toc}
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Modules
|
||||
:caption: API modules
|
||||
|
||||
{toctree}
|
||||
"""
|
||||
(ROOT / "docs" / "sphinx" / "index.rst").write_text(sphinx_index, encoding="utf-8")
|
||||
print(f"wrote {count} module docs")
|
||||
print(f"wrote {count} module docs + {len(repo_entries)} repo READMEs")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue