Skip to content

docs: Migrate to gp-sphinx workspace packages#66

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

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

Conversation

@tony
Copy link
Copy Markdown
Member

@tony tony commented Apr 5, 2026

Summary

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

What changed

  • pyproject.toml / uv.lock replace the repo-managed Sphinx + Furo dependency stack with gp-sphinx==0.0.1a1 from PyPI.
  • docs/conf.py now uses merge_sphinx_config() so shared theme behavior, extensions, fonts, and asset workarounds come from gp-sphinx instead of local boilerplate.
  • Removes vendored docs support files now supplied by shared packages: docs/_ext/sphinx_fonts.py, custom docs CSS/JS, sidebar/page templates, and the local tests/docs/_ext/test_sphinx_fonts.py harness.
  • Removes obsolete mypy overrides tied to the deleted docs module.

Test plan

  • just test
  • just ruff
  • just mypy
  • just build-docs

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.08%. Comparing base (bb8f08f) to head (30113c0).
⚠️ Report is 5 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #66      +/-   ##
==========================================
- Coverage   78.11%   73.08%   -5.04%     
==========================================
  Files          17       14       -3     
  Lines        1211      836     -375     
==========================================
- Hits          946      611     -335     
+ Misses        265      225      -40     

☔ 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 sphinx, furo, sphinx-autodoc-typehints, sphinx-inline-tabs,
  sphinxext-opengraph, sphinx-copybutton, sphinxext-rediraffe, sphinx-design,
  myst-parser, linkify-it-py from dev and docs groups
- Add gp-sphinx==0.0.1a0
- Update uv.lock
why: sphinx_fonts, 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/sphinx_fonts.py
- Delete docs/_static/css/custom.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: sphinx_fonts and test_sphinx_fonts are no longer local modules.
what:
- Remove sphinx_fonts ignore_missing_imports override
- Remove tests.docs._ext.test_sphinx_fonts disable_error_code override
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 ce477ff into master Apr 5, 2026
35 of 36 checks passed
@tony tony deleted the gp-sphinx branch April 5, 2026 18:37
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