Preview gp-sphinx#36 curated default-value rendering#43
Open
Conversation
…ources why: gp-sphinx PR git-pull/gp-sphinx#36 ships curated parameter and data-attribute default rendering. Pinning the gp-sphinx-family deps to that branch via `[tool.uv.sources]` lets this repo's docs preview the user-visible win before the workspace release bump propagates the changes via PyPI. `RetryMiddleware.__init__(retry_exceptions=(<class 'libtmux.exc. LibTmuxException'>,))` now renders as `retry_exceptions=(libtmux_exc.LibTmuxException,)` with `LibTmuxException` linked to its documented exception class in the same `<a class="reference internal"><code class="xref py py-class">…</code></a>` shape that inline `:py:class:` roles produce in body prose. what: - Add `[tool.uv.sources]` overrides for gp-sphinx, sphinx-autodoc-typehints-gp, sphinx-autodoc-api-style, and sphinx-autodoc-fastmcp, all pointing at the `improved-defaults-reprs` branch with the appropriate monorepo subdirectory. - Regenerate `uv.lock`; uv resolves all transitive workspace siblings from the same commit (8c3a1418). - Revert this commit when gp-sphinx>=0.0.1a18 lands and the per-package version pins move forward in the usual workspace bump.
why: Lets the docs pipeline build and publish from this branch so the gp-sphinx#36 preview is reviewable on the live docs site without merging first. Revert this commit before merging the preview to main. what: - Add `improved-defaults-reprs` to the on.push.branches list in .github/workflows/docs.yml so the publish job runs for this branch's pushes.
tony
force-pushed
the
improved-defaults-reprs
branch
from
8db06f7 to
cfc16b8
Compare
…uild why: While gp-sphinx-family deps resolve from the improved-defaults-reprs branch via [tool.uv.sources], uv builds gp-furo-theme from source — its PEP 517 backend is sphinx-vite-builder, which runs pnpm install + vite build at install time. CI runners have no pnpm/Node, so the install fails. Revert this and the uv.sources block once gp-sphinx>=0.0.1a18 publishes. what: - tests.yml: add pnpm/action-setup@v6 + setup-node@v6 before each uv sync step (build job, release job) - docs.yml: same, gated on env.PUBLISH == 'true' to mirror the surrounding steps
why: setup-node's cache:pnpm option requires a pnpm-lock.yaml at the consumer repo root. Our pnpm-lock.yaml lives inside the gp-furo-theme git-source checkout, not in libtmux-mcp. Without the cache option, setup-node still places node on PATH and pnpm runs fine — just without the GH Actions cache layer. what: - tests.yml + docs.yml: drop `cache: pnpm` from each Set up Node step
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #43 +/- ##
=======================================
Coverage 84.91% 84.91%
=======================================
Files 40 40
Lines 2294 2294
Branches 294 294
=======================================
Hits 1948 1948
Misses 261 261
Partials 85 85 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
[tool.uv.sources]so the docs build picks up the changes before a release bump propagates them via PyPI.RetryMiddleware.__init__(and any other middleware default that references documented Python identifiers) now renders source text instead ofrepr(). Specifically,retry_exceptions=(<class 'libtmux.exc.LibTmuxException'>,)becomesretry_exceptions=(libtmux_exc.LibTmuxException,)— andLibTmuxExceptionis wrapped in the same<a class="reference internal"><code class="xref py py-class">…</code></a>shape that inline:py:class:roles produce, linking to the documented exception class on libtmux's docs site.[DO NOT MERGE]commit that adds the branch to.github/workflows/docs.yml'son.push.brancheslist so the live docs site previews the branch. Revert that commit before merging.After gp-sphinx>=0.0.1a18 ships, replace this with a normal version bump (
0.0.1a17→0.0.1a18across the four pinned gp-sphinx-family packages) and revert both commits in this branch.Test plan
uv lockresolves all gp-sphinx-family workspace siblings to commit8c3a1418on the branchuv sync --all-extras --devclean install from git sourcescd docs && just htmlRetryMiddleware.__init__showsretry_exceptions=(libtmux_exc.LibTmuxException,)withxref py py-classstylingdocsworkflow runs against this branch (enabled by the[DO NOT MERGE]commit) and publishes to the docs site for live preview