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.authentication
|
|||
Generated API sheet for ``verae-zapier/authentication``.
|
||||
|
||||
.. include:: authentication.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier.creates.add_numbers
|
|||
Generated API sheet for ``verae-zapier/creates/add_numbers``.
|
||||
|
||||
.. include:: add_numbers.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier.creates.batch_timestamp
|
|||
Generated API sheet for ``verae-zapier/creates/batch_timestamp``.
|
||||
|
||||
.. include:: batch_timestamp.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier.creates.create_timestamp
|
|||
Generated API sheet for ``verae-zapier/creates/create_timestamp``.
|
||||
|
||||
.. include:: create_timestamp.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier.creates.timestamp_and_wait
|
|||
Generated API sheet for ``verae-zapier/creates/timestamp_and_wait``.
|
||||
|
||||
.. include:: timestamp_and_wait.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier.creates.verify_timestamp
|
|||
Generated API sheet for ``verae-zapier/creates/verify_timestamp``.
|
||||
|
||||
.. include:: verify_timestamp.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**Package:** `verae-zapier`
|
||||
**Source:** `packages/verae-zapier/index.js`
|
||||
**Lines:** 81
|
||||
**Lines:** 83
|
||||
|
||||
## What this module is
|
||||
|
||||
|
|
@ -33,6 +33,7 @@ _None extracted._
|
|||
- `./creates/add_numbers`
|
||||
- `./searches/job_status`
|
||||
- `./searches/hash_lookup`
|
||||
- `./searches/tree_lookup`
|
||||
- `./triggers/timestamp_completed`
|
||||
- `zapier-platform-core`
|
||||
- `./package.json`
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier.index
|
|||
Generated API sheet for ``verae-zapier/index``.
|
||||
|
||||
.. include:: index.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier.searches.hash_lookup
|
|||
Generated API sheet for ``verae-zapier/searches/hash_lookup``.
|
||||
|
||||
.. include:: hash_lookup.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
|
|
@ -4,4 +4,4 @@ verae-zapier.searches.job_status
|
|||
Generated API sheet for ``verae-zapier/searches/job_status``.
|
||||
|
||||
.. include:: job_status.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
41
docs/sphinx/modules/verae-zapier/searches/tree_lookup.md
Normal file
41
docs/sphinx/modules/verae-zapier/searches/tree_lookup.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# `verae-zapier/searches/tree_lookup`
|
||||
|
||||
**Package:** `verae-zapier`
|
||||
**Source:** `packages/verae-zapier/searches/tree_lookup.js`
|
||||
**Lines:** 46
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`key`, `noun`, `display`, `label`, `description`, `chain`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `base` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `perform` | `z, bundle` | — | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`async`, `encodeURIComponent`, `request`, `base`, `repeat`
|
||||
|
||||
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-zapier.searches.tree_lookup
|
||||
=================================
|
||||
|
||||
Generated API sheet for ``verae-zapier/searches/tree_lookup``.
|
||||
|
||||
.. include:: tree_lookup.md
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
@ -4,4 +4,4 @@ verae-zapier.triggers.timestamp_completed
|
|||
Generated API sheet for ``verae-zapier/triggers/timestamp_completed``.
|
||||
|
||||
.. include:: timestamp_completed.md
|
||||
:literal:
|
||||
:parser: myst_parser.sphinx_
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue