Skip to content

Docs(ci): Adopt Sphinx inventories - #787

Draft
tony wants to merge 4 commits into
docs-site-deployfrom
sphinx-inventories
Draft

tony wants to merge 4 commits into
docs-site-deployfrom
sphinx-inventories

Conversation

@tony

@tony tony commented Oct 18, 2026 •

Copy link
Copy Markdown
Member

Adopt the Sphinx inventories from libtmux/docs#166, so readers can download the port/version inventory and ordinary Sphinx sites can link to its rendered entities. Both builder and publisher references select 32526a20f7de5835a0a4ea5c13d183deb9e1b07d.

Rebased onto docs-site-deploy at 137abf00286cbbf1025cf189f03a1343875ecbdb. The final documentation workflow file is byte-identical to the previous feature tip; the branch difference from this base is the paired references.

Validation

  • All four feature patches remain. The first patch changes only its replaced base-reference context; the other three compare equal. The tracked tree is clean and whitespace checks pass.
  • Actionlint 1.7.12 reports the same 2 queue-syntax diagnostic(s) as the fetched base; there are no added diagnostics.
  • The fresh documentation workflow succeeds at e7282f9ed5ce9d851d68d7369bca632e8c23f146. Its 1 original scoped artifact(s) pass both stock Sphinx/MyST runtimes: 35,622 records, 2,742 owned pages/footers and 57 references in each markup per runtime. Original files/archives retain their hashes, and the actual tested source tree matches this branch tree.

Draft for review. Canonical rollout remains held.

Native checks pass or are configured skips at the current readback.

@codecov

codecov Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.37%. Comparing base (137abf0) to head (e7282f9).

Additional details and impacted files
@@                Coverage Diff                @@
##           docs-site-deploy     #787   +/-   ##
=================================================
  Coverage             52.37%   52.37%           
=================================================
  Files                    26       26           
  Lines                  3729     3729           
  Branches                747      747           
=================================================
  Hits                   1953     1953           
  Misses                 1472     1472           
  Partials                304      304           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tony
tony force-pushed the sphinx-inventories branch 12 times, most recently from 7407bf0 to fb471b3 Compare October 21, 2026 00:14
tony added 4 commits October 21, 2026 22:14
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
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@31ed443
why: Use the inventory producer rebased onto the current docs main.
The shared workflow also installs Julia's tested tmux runtime.

what:
- Pin the build and deploy workflows to the same revision

Producer: afb819293ce536e4df3d9ecd8e619710591f27f2
why: Keep the site builder and publisher on the reviewed producer after rebasing docs onto current main.

what:
- Pin both workflow references to the rebased docs revision.
@tony
tony force-pushed the sphinx-inventories branch from 6be68a1 to e7282f9 Compare October 22, 2026 03:19

This branch has not been deployed

No deployments
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