spiri-docs

Sphinx extension for Spiri controlled documents — operational manuals and anything else with a revision number that someone outside the company relies on.

# docs/conf.py
extensions = ["myst_parser", "spiri_docs"]

Everything follows from a revisions.yaml beside docs/:

document_number: SPIRI-OM-001
regulator_facing: true
distribution_statement: Uncontrolled when printed.

revisions:
  - revision: "1.0"
    date: 2026-07-19
    effective_date: 2026-08-01
    author: A. Author
    approver: B. Approver
    summary: Initial issue.

On every build the extension:

  • validates the file — a regulator_facing document without an effective_date or approver fails the build rather than shipping;
  • sets version and release to the current revision;
  • exposes {{ document_number }}, {{ revision }}, {{ effective_date }}, {{ approver }} and friends as MyST substitutions for the cover page;
  • stamps document number, revision and Page N of M into the PDF footer;
  • names the PDF SPIRI-OM-001_rev1.0.pdf.

And provides one directive:

```{revision-history}


which renders the history newest-first, showing only the columns the document
actually populates.

## Why an extension and not the template

`spiri-doc-template` runs once, at project generation. This runs on every build.
Validation, revision plumbing, and PDF document control have to hold every time
the docs are built — a template can only put a correct file down on day one and
has no way to detect drift afterwards. Theme, CSS and structure stay in the
template, where being decided once is the point.

## Configuration

| Option | Default | Meaning |
| --- | --- | --- |
| `spiri_docs_revisions` | `"../revisions.yaml"` | Path to the revision file, relative to `conf.py`. |

## Not here yet

Hazard admonitions (DANGER / WARNING / CAUTION / NOTICE). Which standard to
follow — ANSI Z535.6, ISO 3864 — is an editorial decision, and shipping markup
before it is made means migrating every manual later. Sphinx's built-in
`danger`, `warning`, `caution` and `note` are fine in the meantime.

Project links

Data verified by PyPI on Jul 19, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.2.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for spiri-traverseda from gravatar.com spiri-traverseda

GitHub Statistics

Data verified by PyPI on Jul 19, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.11

Tags

document-control documentation sphinx technical-manual

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spiri_docs-0.1.1.tar.gz (43.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spiri_docs-0.1.1-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file spiri_docs-0.1.1.tar.gz.

File metadata

  • Download URL: spiri_docs-0.1.1.tar.gz
  • Upload date:
  • Size: 43.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for spiri_docs-0.1.1.tar.gz
Algorithm Hash digest
SHA256 fd42b745919c38aa4ada784e4620b12f5eef2ee7330185444b6bc55537045869
MD5 88c69e1ebae0fcee578741121ca68d6a
BLAKE2b-256 cd974f07b4cd5add88fd9861db12b7b0e7463c585a70cb7fd3d5c5a1b3bf8e33

See more details on using hashes here.

Provenance

The following attestation bundles were made for spiri_docs-0.1.1.tar.gz:

Publisher: publish.yml on spiri-robotics/spiri-docs-tooling

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file spiri_docs-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: spiri_docs-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for spiri_docs-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3d64fd0585a4d367675b8847f7fbbf807e5f60ea2306db0f1dc9fb65a11e5b3f
MD5 a863a87de4e1619c66e37b4eeaaf13c6
BLAKE2b-256 a86353d0ff3264f2d9ecbf6d5d484a687427ae540cca9b6b457713ab4a3a2cb8

See more details on using hashes here.

Provenance

The following attestation bundles were made for spiri_docs-0.1.1-py3-none-any.whl:

Publisher: publish.yml on spiri-robotics/spiri-docs-tooling

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page