Skip to content

chore(docs): adopt gp-sphinx v0.0.1a8#1036

Merged
tony merged 2 commits intomasterfrom
autodoc-improvements
Apr 12, 2026
Merged

chore(docs): adopt gp-sphinx v0.0.1a8#1036
tony merged 2 commits intomasterfrom
autodoc-improvements

Conversation

@tony
Copy link
Copy Markdown
Member

@tony tony commented Apr 12, 2026

Summary

  • Bumps gp-sphinx workspace pins from 0.0.1a7 β†’ 0.0.1a8
  • Refreshes uv.lock against the published workspace
  • Renames sphinx-argparse-neo==0.0.1a7 β†’ sphinx-autodoc-argparse==0.0.1a8 and updates the extension path in docs/conf.py
  • Adds a CHANGES bullet noting the bump

What's new in gp-sphinx 0.0.1a8

  • ArgparseDomain (:argparse:* roles, indices, xref resolution)
  • CSS namespace unification under gp-sphinx-* BEM
  • sphinx>=8.1 floor with typed env.domains.* accessors
  • Package renames: sphinx-autodoc-layout β†’ sphinx-ux-autodoc-layout, sphinx-autodoc-badges β†’ sphinx-ux-badges
  • py.typed marker added to sphinx-autodoc-typehints-gp
  • # bump-version: skip-file sentinel in the bump script
  • See: https://pypi.org/project/gp-sphinx/0.0.1a8/

Test plan

  • uv sync --all-extras --group dev β€” clean
  • uv run ruff check . --fix --show-fixes β€” all passed
  • uv run ruff format . β€” no changes
  • uv run mypy β€” no issues
  • uv run pytest -q β€” 797 passed, 2 skipped
  • just build-docs β€” build succeeded, 77 warnings

why: Adopt the v0.0.1a8 release of the shared docs platform β€”
  argparse domain, CSS namespace unification under gp-sphinx-*,
  sphinx>=8.1 floor, typed env.domains.* accessors, autodoc
  layout and badges package renames, py.typed marker for
  typehints-gp.
what:
- Bump gp-sphinx and sphinx-autodoc-api-style pins from
  0.0.1a7 to 0.0.1a8 across every dependency group
- Replace sphinx-argparse-neo==0.0.1a7 with
  sphinx-autodoc-argparse==0.0.1a8, and update the extension
  name in docs/conf.py from sphinx_argparse_neo.exemplar to
  sphinx_autodoc_argparse.exemplar
- Refresh uv.lock against the published workspace

See also: https://pypi.org/project/gp-sphinx/0.0.1a8/
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 12, 2026

Codecov Report

βœ… All modified and coverable lines are covered by tests.
βœ… Project coverage is 81.96%. Comparing base (8370db6) to head (f111878).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1036   +/-   ##
=======================================
  Coverage   81.96%   81.96%           
=======================================
  Files          28       28           
  Lines        2545     2545           
  Branches      485      485           
=======================================
  Hits         2086     2086           
  Misses        328      328           
  Partials      131      131           

β˜” View full report in Codecov by Sentry.
πŸ“’ 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 autodoc-improvements branch from f3336c7 to f111878 Compare April 12, 2026 21:40
@tony tony marked this pull request as ready for review April 12, 2026 21:40
@tony tony merged commit 7ae22fb into master Apr 12, 2026
13 checks passed
@tony tony deleted the autodoc-improvements branch April 12, 2026 21:45
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