Skip to content

Docs(ci): Adopt Sphinx inventories - #45

Draft
tony wants to merge 2 commits into
masterfrom
sphinx-inventories
Draft

tony wants to merge 2 commits into
masterfrom
sphinx-inventories

Conversation

@tony

@tony tony commented Oct 18, 2026 •

Copy link
Copy Markdown
Contributor

Pin the documentation producer and publisher together to the current Sphinx inventory producer from libtmux/docs#166. It provides full and scoped inventories, durable portable labels and native aliases, version-aware footer downloads and a linked setup guide.

The diff is confined to the paired producer references in .github/workflows/docs.yml.

Validation

  • Parsed YAML verifies that the docs checkout/build and publication references select the same exact commit.
  • Actionlint 1.7.12 passes.
  • The four Ruby docs-workflow tests pass (22 assertions).

Keep this PR and the docs producer PR as drafts for review. Canonical rollout and final publication receipts remain pending.

The current producer also supplies a tested, source-bound Go guide so quickstart changes cannot break its excerpt anchors. New CI results at ab53f4907 are pending.

why: Sphinx consumers need discoverable port references, and the root
publisher needs a catalog for the selected default version.

what:
- Adopt scoped inventories, catalogs and footer discovery
- Adopt the reference fixes and generic links from docs PR 157
- Use the shared publisher's locked uv, Ruff and ty tooling
- Restrict scoped inventory to the actual port/version mount
- Place inventory setup help under the site meta section
- Declare the three-day uv cooldown for portable locked installs
- Make the Python CLI checks executable for Linux Ruff
- Keep decorative kind marks out of row and inventory names
- Resolve command options under native Sphinx program contexts
- Keep both docs workflow pins on the same revision

validation: YAML, callee bindings, paired pins and minimal diffs pass.
The combined docs branch passes 221 site and 23 Swift model checks,
Ruff, formatting, ty and TypeScript checks; 23 assembled-tree contracts
were skipped. Complete publication evidence remains a separate gate.

Docs source: libtmux/docs@205ecac
@tony
tony force-pushed the sphinx-inventories branch from a9b9fd5 to 5488985 Compare October 20, 2026 22:03
why: Documentation builds and their publisher must share the producer
that exports durable inventories and working footer help links.

what:
- Pin the producer and publisher to the current inventory draft.
- Adopt scoped tmux inventories, verified Sphinx examples and accessible
  setup links from libtmux/docs#166.

Producer: libtmux/docs@ab53f49
@tony
tony force-pushed the sphinx-inventories branch from 5488985 to 120221f Compare October 20, 2026 23:56

This branch had an error being deployed

1 failed (outdated) deployment
docs-preview — a9b9fd51 Deployed Oct 20, 2026 by tony via publish (pr-45, pr, false, docs-preview, true) / publish #222
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant