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
156 changed files with 4499 additions and 124 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)
|
||||
|
|
|
|||
|
|
@ -1,9 +1,33 @@
|
|||
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
|
||||
|
||||
repos/overview
|
||||
repos/verae-ops
|
||||
repos/zappier
|
||||
repos/verae-zapier-middleware
|
||||
repos/verae-zapier
|
||||
repos/verae-activate
|
||||
repos/verae-request-splitter
|
||||
repos/verae-archive-worm
|
||||
repos/verae-archive-aggregator
|
||||
repos/verae-tree-node
|
||||
repos/verae-fleet
|
||||
repos/verae-zapier-simulator
|
||||
repos/zapier-user-docs
|
||||
repos/docs-master
|
||||
repos/verae-nats-process
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Modules
|
||||
:caption: API modules
|
||||
|
||||
modules/zappier/accounts
|
||||
modules/zappier/admin-users
|
||||
|
|
@ -88,4 +112,29 @@ Verae × Zapier module reference
|
|||
modules/verae-zapier/index
|
||||
modules/verae-zapier/searches/hash_lookup
|
||||
modules/verae-zapier/searches/job_status
|
||||
modules/verae-zapier/searches/tree_lookup
|
||||
modules/verae-zapier/triggers/timestamp_completed
|
||||
modules/verae-fleet/agent
|
||||
modules/verae-fleet/classify
|
||||
modules/verae-fleet/cli
|
||||
modules/verae-fleet/health
|
||||
modules/verae-fleet/load
|
||||
modules/verae-fleet/machines
|
||||
modules/verae-fleet/monitor
|
||||
modules/verae-fleet/rtt
|
||||
modules/verae-fleet/server
|
||||
modules/verae-fleet/ssh
|
||||
modules/verae-fleet/supervisor
|
||||
modules/verae-fleet/worker
|
||||
modules/verae-tree-node/merkle
|
||||
modules/verae-archive-worm/archive
|
||||
modules/verae-archive-worm/bloom
|
||||
modules/verae-archive-aggregator/aggregate
|
||||
modules/verae-request-splitter/splitRequest
|
||||
modules/verae-nats-process/handle
|
||||
modules/verae-nats-process/subjects
|
||||
modules/verae-nats-process/worker
|
||||
modules/verae-zapier-simulator/monitors
|
||||
modules/verae-zapier-simulator/pipeline
|
||||
modules/verae-zapier-simulator/server
|
||||
modules/verae-zapier-simulator/trace
|
||||
|
|
|
|||
25
docs/sphinx/latex-index.rst
Normal file
25
docs/sphinx/latex-index.rst
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
Verae Time × Zapier — repository READMEs
|
||||
==========================================
|
||||
|
||||
LaTeX/PDF companion to the Sphinx HTML API sheets.
|
||||
Public: https://zapier.georgelambert.org/sphinx/verae-zapier-modules.pdf
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Repository READMEs
|
||||
|
||||
repos/overview
|
||||
repos/verae-ops
|
||||
repos/zappier
|
||||
repos/verae-zapier-middleware
|
||||
repos/verae-zapier
|
||||
repos/verae-activate
|
||||
repos/verae-request-splitter
|
||||
repos/verae-archive-worm
|
||||
repos/verae-archive-aggregator
|
||||
repos/verae-tree-node
|
||||
repos/verae-fleet
|
||||
repos/verae-zapier-simulator
|
||||
repos/zapier-user-docs
|
||||
repos/docs-master
|
||||
repos/verae-nats-process
|
||||
|
|
@ -4,4 +4,4 @@ verae-activate.authentication
|
|||
Generated API sheet for ``verae-activate/authentication``.
|
||||
|
||||
.. include:: authentication.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-activate.creates.add_numbers
|
|||
Generated API sheet for ``verae-activate/creates/add_numbers``.
|
||||
|
||||
.. include:: add_numbers.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-activate.creates.echo
|
|||
Generated API sheet for ``verae-activate/creates/echo``.
|
||||
|
||||
.. include:: echo.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-activate.creates.sha256
|
|||
Generated API sheet for ``verae-activate/creates/sha256``.
|
||||
|
||||
.. include:: sha256.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-activate.creates.timestamp
|
|||
Generated API sheet for ``verae-activate/creates/timestamp``.
|
||||
|
||||
.. include:: timestamp.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-activate.index
|
|||
Generated API sheet for ``verae-activate/index``.
|
||||
|
||||
.. include:: index.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
41
docs/sphinx/modules/verae-archive-aggregator/aggregate.md
Normal file
41
docs/sphinx/modules/verae-archive-aggregator/aggregate.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# `verae-archive-aggregator/aggregate`
|
||||
|
||||
**Package:** `verae-archive-aggregator`
|
||||
**Source:** `packages/verae-archive-aggregator/src/aggregate.js`
|
||||
**Lines:** 67
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-archive-aggregator`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`aggregateAttached`, `mergeReceipts`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `aggregateAttached` | `{ sha256, tenantId, kinds = ['publicMeta', 'privateMeta', 'file'], archives }` | opts: `object`, opts.sha256: `string`, opts.tenantId: `string`, opts.kinds: `string[]`, opts.timeoutMs: `number` | `{ archivesQueried: boolean, archiveReplies: number, records: object[], silent: string[] ` — } | see Call graph |
|
||||
| `mergeReceipts` | `chainReceipts, archiveRecords` | chainReceipts: `object[]`, archiveRecords: `object[]` | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`mock`, `aggregateAttached`, `query`, `push`, `includes`, `mergeReceipts`, `map`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
verae-archive-aggregator.aggregate
|
||||
==================================
|
||||
|
||||
Generated API sheet for ``verae-archive-aggregator/aggregate``.
|
||||
|
||||
.. include:: aggregate.md
|
||||
:parser: myst_parser.sphinx_
|
||||
48
docs/sphinx/modules/verae-archive-worm/archive.md
Normal file
48
docs/sphinx/modules/verae-archive-worm/archive.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
# `verae-archive-worm/archive`
|
||||
|
||||
**Package:** `verae-archive-worm`
|
||||
**Source:** `packages/verae-archive-worm/src/archive.js`
|
||||
**Lines:** 41
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-archive-worm`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`WormArchive`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `WormArchive` |
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `archiveId` |
|
||||
| `put` | `put` |
|
||||
| `query` | `sha256` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `./bloom.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`constructor`, `put`, `toLowerCase`, `get`, `push`, `toISOString`, `set`, `add`, `null`, `records`, `query`, `mightHave`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
7
docs/sphinx/modules/verae-archive-worm/archive.rst
Normal file
7
docs/sphinx/modules/verae-archive-worm/archive.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-archive-worm.archive
|
||||
==========================
|
||||
|
||||
Generated API sheet for ``verae-archive-worm/archive``.
|
||||
|
||||
.. include:: archive.md
|
||||
:parser: myst_parser.sphinx_
|
||||
49
docs/sphinx/modules/verae-archive-worm/bloom.md
Normal file
49
docs/sphinx/modules/verae-archive-worm/bloom.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
# `verae-archive-worm/bloom`
|
||||
|
||||
**Package:** `verae-archive-worm`
|
||||
**Source:** `packages/verae-archive-worm/src/bloom.js`
|
||||
**Lines:** 47
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-archive-worm`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`Bloom`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `Bloom` |
|
||||
|
||||
## Functions
|
||||
|
||||
_No top-level functions extracted._
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `m = 16384, k = 4` |
|
||||
| `hashes` | `s` |
|
||||
| `add` | `s` |
|
||||
| `mightHave` | `s` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`membership`, `constructor`, `alloc`, `ceil`, `hashes`, `createHash`, `update`, `digest`, `readUInt32BE`, `push`, `add`, `maybe`, `mightHave`, `every`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
7
docs/sphinx/modules/verae-archive-worm/bloom.rst
Normal file
7
docs/sphinx/modules/verae-archive-worm/bloom.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-archive-worm.bloom
|
||||
========================
|
||||
|
||||
Generated API sheet for ``verae-archive-worm/bloom``.
|
||||
|
||||
.. include:: bloom.md
|
||||
:parser: myst_parser.sphinx_
|
||||
51
docs/sphinx/modules/verae-fleet/agent.md
Normal file
51
docs/sphinx/modules/verae-fleet/agent.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
# `verae-fleet/agent`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/agent.js`
|
||||
**Lines:** 87
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`startAgent`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `json` | `res, code, obj` | — | `unknown` | see Call graph |
|
||||
| `readBody` | `req` | — | `unknown` | see Call graph |
|
||||
| `startAgent` | `{ port = PORT, bind = BIND } = {}` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `startAgent` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `node:child_process`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`join`, `dirname`, `fileURLToPath`, `json`, `writeHead`, `end`, `stringify`, `readBody`, `push`, `concat`, `toString`, `parse`, `startAgent`, `createServer`, `async`, `keys`, `has`, `get`, `spawn`, `set`, `on`, `delete`, `kill`, `listen`, `write`, `close`, `values`, `clear`, `basename`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
7
docs/sphinx/modules/verae-fleet/agent.rst
Normal file
7
docs/sphinx/modules/verae-fleet/agent.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.agent
|
||||
=================
|
||||
|
||||
Generated API sheet for ``verae-fleet/agent``.
|
||||
|
||||
.. include:: agent.md
|
||||
:parser: myst_parser.sphinx_
|
||||
40
docs/sphinx/modules/verae-fleet/classify.md
Normal file
40
docs/sphinx/modules/verae-fleet/classify.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# `verae-fleet/classify`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/classify.js`
|
||||
**Lines:** 30
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`classifyService`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `classifyService` | `sv` | — | `'operational'|'degraded'|'down'` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`classifyService`, `filter`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
7
docs/sphinx/modules/verae-fleet/classify.rst
Normal file
7
docs/sphinx/modules/verae-fleet/classify.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
verae-fleet.classify
|
||||
====================
|
||||
|
||||
Generated API sheet for ``verae-fleet/classify``.
|
||||
|
||||
.. include:: classify.md
|
||||
:parser: myst_parser.sphinx_
|
||||
62
docs/sphinx/modules/verae-fleet/cli.md
Normal file
62
docs/sphinx/modules/verae-fleet/cli.md
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
# `verae-fleet/cli`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/cli.js`
|
||||
**Lines:** 146
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
_No named `export` / `module.exports` keys detected._
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `print` | `obj` | — | `unknown` | see Call graph |
|
||||
| `help` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `api` | `method, pathname` | — | `unknown` | see Call graph |
|
||||
| `main` | `(none)` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `print` | ``verae-fleet
|
||||
|
||||
list services, config files, replica min/max
|
||||
serve start floors + monitor + UI ${BASE}/
|
||||
monitor same without printing extra
|
||||
status GET daemon status
|
||||
start <service> turn on, spawn up to min
|
||||
stop <service|instance> turn off (service disable` |
|
||||
| `print` | `r.body` |
|
||||
| `print` | `{ error: err.message, hint: 'Is `verae-fleet serve` running?' }` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `./load.js`
|
||||
- `./supervisor.js`
|
||||
- `./monitor.js`
|
||||
- `./server.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`loadFleet`, `slice`, `print`, `write`, `stringify`, `help`, `off`, `pause`, `json`, `identityFile`, `login`, `api`, `request`, `on`, `push`, `concat`, `toString`, `resolve`, `parse`, `end`, `main`, `listServices`, `padEnd`, `padStart`, `import`, `find`, `sshCheck`, `keys`, `startService`, `tick`, `start`, `startControlServer`, `async`, `stop`, `stopAll`, `exit`, `test`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue