Skip to content

docs: Migrate to gp-sphinx workspace packages#52

Merged
tony merged 4 commits intomasterfrom
gp-sphinx
Apr 5, 2026
Merged

docs: Migrate to gp-sphinx workspace packages#52
tony merged 4 commits intomasterfrom
gp-sphinx

Conversation

@tony
Copy link
Copy Markdown
Member

@tony tony commented Apr 5, 2026

Summary

Migrates g docs from repo-local Sphinx extensions/theme/config to the published gp-sphinx shared documentation platform.

What changed

  • pyproject.toml / uv.lock replace the manual Sphinx/Furo dependency stack with gp-sphinx==0.0.1a1 from PyPI.
  • docs/conf.py is rewritten around merge_sphinx_config() so shared theme settings, fonts, extension defaults, and JS workarounds come from gp-sphinx.
  • Removes vendored docs implementation now shipped by shared packages: docs/_ext/argparse_*, docs/_ext/cli_usage_lexer.py, the embedded docs/_ext/sphinx_argparse_neo/ package, docs/_ext/sphinx_fonts.py, custom docs CSS/JS/templates, and the corresponding tests/docs/_ext/ coverage.
  • Removes obsolete mypy overrides for the deleted local docs modules.

Test plan

  • make test
  • make ruff
  • make mypy
  • make build_docs

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.89%. Comparing base (61c95ff) to head (5207342).

Additional details and impacted files
@@             Coverage Diff             @@
##           master      #52       +/-   ##
===========================================
+ Coverage   85.86%   96.89%   +11.03%     
===========================================
  Files          27        5       -22     
  Lines        2589      129     -2460     
===========================================
- Hits         2223      125     -2098     
+ Misses        366        4      -362     

☔ 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 marked this pull request as ready for review April 5, 2026 17:59
tony added 4 commits April 5, 2026 13:01
why: Consolidate docs dependencies into the gp-sphinx shared platform.
what:
- Remove individual sphinx extension deps from dev and docs groups
- Add gp-sphinx==0.0.1a0 and sphinx-argparse-neo==0.0.1a0
- Keep aafigure and pillow (project-specific)
- Update uv.lock
why: sphinx_fonts, argparse extensions, templates, static assets, and
     spa-nav.js are now provided by gp-sphinx packages. Upstream
     extension tests are covered by the PyPI packages.
what:
- Delete docs/_ext/ entirely (sphinx_fonts, argparse_*, sphinx_argparse_neo/)
- Delete docs/_static/css/custom.css, css/argparse-highlight.css, js/spa-nav.js
- Delete docs/_templates/ (page.html, sidebar/brand.html, sidebar/projects.html)
- Delete tests/docs/ entirely
- Rewrite docs/conf.py to use merge_sphinx_config() and make_linkcode_resolve()
why: Bundled extension modules are now provided by PyPI packages.
what:
- Remove mypy overrides for sphinx_fonts, cli_usage_lexer, and related modules
why: The gp-sphinx docs stack moved to v0.0.1a1 and downstream branches need matching pins and locks.
what:
- bump gp-sphinx docs dependency pins from 0.0.1a0 to 0.0.1a1
- refresh uv.lock to resolve the published v0.0.1a1 packages
@tony tony merged commit a9696cf into master Apr 5, 2026
7 checks passed
@tony tony deleted the gp-sphinx branch April 5, 2026 18:34
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.

2 participants