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
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.app
|
|||
Generated API sheet for ``verae-zapier-middleware/app``.
|
||||
|
||||
.. include:: app.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.clients.veraeClient
|
|||
Generated API sheet for ``verae-zapier-middleware/clients/veraeClient``.
|
||||
|
||||
.. include:: veraeClient.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.config
|
|||
Generated API sheet for ``verae-zapier-middleware/config``.
|
||||
|
||||
.. include:: config.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.debug.config
|
|||
Generated API sheet for ``verae-zapier-middleware/debug/config``.
|
||||
|
||||
.. include:: config.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.debug.index
|
|||
Generated API sheet for ``verae-zapier-middleware/debug/index``.
|
||||
|
||||
.. include:: index.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.debug.logger
|
|||
Generated API sheet for ``verae-zapier-middleware/debug/logger``.
|
||||
|
||||
.. include:: logger.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.debug.redact
|
|||
Generated API sheet for ``verae-zapier-middleware/debug/redact``.
|
||||
|
||||
.. include:: redact.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.debug.trace-context
|
|||
Generated API sheet for ``verae-zapier-middleware/debug/trace-context``.
|
||||
|
||||
.. include:: trace-context.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.debug.trace
|
|||
Generated API sheet for ``verae-zapier-middleware/debug/trace``.
|
||||
|
||||
.. include:: trace.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.errors
|
|||
Generated API sheet for ``verae-zapier-middleware/errors``.
|
||||
|
||||
.. include:: errors.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.index
|
|||
Generated API sheet for ``verae-zapier-middleware/index``.
|
||||
|
||||
.. include:: index.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.lib.receiptPdf
|
|||
Generated API sheet for ``verae-zapier-middleware/lib/receiptPdf``.
|
||||
|
||||
.. include:: receiptPdf.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.lib.tokens
|
|||
Generated API sheet for ``verae-zapier-middleware/lib/tokens``.
|
||||
|
||||
.. include:: tokens.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.middleware.authenticate
|
|||
Generated API sheet for ``verae-zapier-middleware/middleware/authenticate``.
|
||||
|
||||
.. include:: authenticate.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.middleware.rateLimit
|
|||
Generated API sheet for ``verae-zapier-middleware/middleware/rateLimit``.
|
||||
|
||||
.. include:: rateLimit.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.nats.connection
|
|||
Generated API sheet for ``verae-zapier-middleware/nats/connection``.
|
||||
|
||||
.. include:: connection.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.nats.publishers
|
|||
Generated API sheet for ``verae-zapier-middleware/nats/publishers``.
|
||||
|
||||
.. include:: publishers.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/nats/subjects.js`
|
||||
**Lines:** 44
|
||||
**Lines:** 48
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -26,7 +26,7 @@ _No imports detected._
|
|||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`freeze`, `names`
|
||||
`freeze`, `node`, `names`
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.nats.subjects
|
|||
Generated API sheet for ``verae-zapier-middleware/nats/subjects``.
|
||||
|
||||
.. include:: subjects.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.nats.wait
|
|||
Generated API sheet for ``verae-zapier-middleware/nats/wait``.
|
||||
|
||||
.. include:: wait.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.routes.authRoutes
|
|||
Generated API sheet for ``verae-zapier-middleware/routes/authRoutes``.
|
||||
|
||||
.. include:: authRoutes.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/routes/hashRoutes.js`
|
||||
**Lines:** 22
|
||||
**Lines:** 24
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.routes.hashRoutes
|
|||
Generated API sheet for ``verae-zapier-middleware/routes/hashRoutes``.
|
||||
|
||||
.. include:: hashRoutes.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.routes.index
|
|||
Generated API sheet for ``verae-zapier-middleware/routes/index``.
|
||||
|
||||
.. include:: index.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.routes.objectRoutes
|
|||
Generated API sheet for ``verae-zapier-middleware/routes/objectRoutes``.
|
||||
|
||||
.. include:: objectRoutes.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.routes.receiptRoutes
|
|||
Generated API sheet for ``verae-zapier-middleware/routes/receiptRoutes``.
|
||||
|
||||
.. include:: receiptRoutes.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.routes.statusRoutes
|
|||
Generated API sheet for ``verae-zapier-middleware/routes/statusRoutes``.
|
||||
|
||||
.. include:: statusRoutes.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.routes.tenantRoutes
|
|||
Generated API sheet for ``verae-zapier-middleware/routes/tenantRoutes``.
|
||||
|
||||
.. include:: tenantRoutes.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.routes.timestampRoutes
|
|||
Generated API sheet for ``verae-zapier-middleware/routes/timestampRoutes``.
|
||||
|
||||
.. include:: timestampRoutes.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.routes.verifyRoutes
|
|||
Generated API sheet for ``verae-zapier-middleware/routes/verifyRoutes``.
|
||||
|
||||
.. include:: verifyRoutes.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.routes.webhookRoutes
|
|||
Generated API sheet for ``verae-zapier-middleware/routes/webhookRoutes``.
|
||||
|
||||
.. include:: webhookRoutes.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.services.authService
|
|||
Generated API sheet for ``verae-zapier-middleware/services/authService``.
|
||||
|
||||
.. include:: authService.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.services.entitlementService
|
|||
Generated API sheet for ``verae-zapier-middleware/services/entitlementService``.
|
||||
|
||||
.. include:: entitlementService.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.services.tenantService
|
|||
Generated API sheet for ``verae-zapier-middleware/services/tenantService``.
|
||||
|
||||
.. include:: tenantService.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier-middleware`
|
||||
**Source:** `packages/verae-zapier-middleware/src/services/timestampService.js`
|
||||
**Lines:** 160
|
||||
**Lines:** 170
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ _None extracted._
|
|||
| `getJobStatus` | `ctx, jobId` | ctx: `object`, jobId: `string` | `unknown` | see Call graph |
|
||||
| `getBatchJobStatus` | `ctx, body` | ctx: `object` | `unknown` | see Call graph |
|
||||
| `getJobVerification` | `ctx, jobId` | ctx: `object`, jobId: `string` | `unknown` | see Call graph |
|
||||
| `lookupHash` | `ctx, sha256` | ctx: `object`, sha256: `string` | `unknown` | see Call graph |
|
||||
| `lookupHash` | `ctx, sha256, opts = {}` | ctx: `object`, sha256: `string` | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.services.timestampService
|
|||
Generated API sheet for ``verae-zapier-middleware/services/timestampService``.
|
||||
|
||||
.. include:: timestampService.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.services.verifyService
|
|||
Generated API sheet for ``verae-zapier-middleware/services/verifyService``.
|
||||
|
||||
.. include:: verifyService.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.services.webhookService
|
|||
Generated API sheet for ``verae-zapier-middleware/services/webhookService``.
|
||||
|
||||
.. include:: webhookService.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.store.blobs
|
|||
Generated API sheet for ``verae-zapier-middleware/store/blobs``.
|
||||
|
||||
.. include:: blobs.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.store.db
|
|||
Generated API sheet for ``verae-zapier-middleware/store/db``.
|
||||
|
||||
.. include:: db.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.store.jobWatchers
|
|||
Generated API sheet for ``verae-zapier-middleware/store/jobWatchers``.
|
||||
|
||||
.. include:: jobWatchers.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.store.tenants
|
|||
Generated API sheet for ``verae-zapier-middleware/store/tenants``.
|
||||
|
||||
.. include:: tenants.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.store.usage
|
|||
Generated API sheet for ``verae-zapier-middleware/store/usage``.
|
||||
|
||||
.. include:: usage.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.store.webhooks
|
|||
Generated API sheet for ``verae-zapier-middleware/store/webhooks``.
|
||||
|
||||
.. include:: webhooks.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.workers.inProcessJobPoller
|
|||
Generated API sheet for ``verae-zapier-middleware/workers/inProcessJobPoller``.
|
||||
|
||||
.. include:: inProcessJobPoller.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.workers.jobPollerWorker
|
|||
Generated API sheet for ``verae-zapier-middleware/workers/jobPollerWorker``.
|
||||
|
||||
.. include:: jobPollerWorker.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier-middleware.workers.webhookWorker
|
|||
Generated API sheet for ``verae-zapier-middleware/workers/webhookWorker``.
|
||||
|
||||
.. include:: webhookWorker.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue