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
|
|
@ -1,13 +1,44 @@
|
|||
# Sphinx config for Verae × Zapier module reference.
|
||||
# Sphinx config for Verae × Zapier (HTML + LaTeX).
|
||||
project = "Verae Time × Zapier"
|
||||
author = "Verae"
|
||||
release = "0.1.0"
|
||||
extensions = []
|
||||
extensions = ["myst_parser"]
|
||||
myst_enable_extensions = ["colon_fence", "deflist", "tasklist"]
|
||||
source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
|
||||
templates_path = ["_templates"]
|
||||
exclude_patterns = ["_build"]
|
||||
html_theme = "alabaster"
|
||||
html_static_path = []
|
||||
html_theme_options = {
|
||||
"description": "Public module reference",
|
||||
"fixed_sidebar": True,
|
||||
}
|
||||
master_doc = "index"
|
||||
latex_engine = "pdflatex"
|
||||
latex_elements = {
|
||||
"papersize": "letterpaper",
|
||||
"pointsize": "10pt",
|
||||
"preamble": r"\usepackage{xcolor}\usepackage{booktabs}",
|
||||
}
|
||||
latex_documents = [
|
||||
(master_doc, "verae-zapier-modules.tex", "Verae Time × Zapier Module Reference", author, "manual"),
|
||||
(
|
||||
"latex-index",
|
||||
"verae-zapier-modules.tex",
|
||||
"Verae Time × Zapier Repository READMEs",
|
||||
author,
|
||||
"manual",
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
def _drop_svg_images(app, doctree, fromdocname):
|
||||
from docutils import nodes
|
||||
|
||||
for node in list(doctree.findall(nodes.image)):
|
||||
uri = node.get("uri") or ""
|
||||
if uri.endswith(".svg"):
|
||||
node.replace_self(nodes.paragraph(text=f"[SVG diagram {uri} — see HTML catalog]"))
|
||||
|
||||
|
||||
def setup(app):
|
||||
app.connect("doctree-resolved", _drop_svg_images)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue