Conversation
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 - 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/ bundled extensions (sphinx_fonts, argparse_*, sphinx_argparse_neo/)
- Keep docs/_ext/vcspull_console_lexer.py, vcspull_output_lexer.py (project-specific)
- 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/ upstream extension tests
- Keep tests/docs/_ext/test_vcspull_*_lexer.py (project-specific)
- 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
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #541 +/- ##
=======================================
Coverage 84.27% 84.27%
=======================================
Files 29 29
Lines 3809 3809
Branches 758 758
=======================================
Hits 3210 3210
Misses 377 377
Partials 222 222 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
why: Mypy was flagging the console lexer fallback import path and stale test ignores even though the docs extensions are loaded from docs/_ext on sys.path. what: - replace the console lexer try/except import with the supported top-level import - remove unused import-not-found ignores from the lexer tests - keep lexer behavior unchanged while restoring a clean mypy run
why: The docs lexer tests import modules from docs/_ext, but the default mypy scope only covered src and tests so uv run mypy failed on unresolved imports and reported a stale docutils override. what: - add docs/_ext to the default mypy files list - remove the unused docutils override entries - keep the existing shtab and pygments import exceptions
why: The shared docs packages moved to 0.0.1a1 and this migration branch should match the published versions. what: - bump gp-sphinx and sphinx-argparse-neo pins from 0.0.1a0 to 0.0.1a1 - refresh uv.lock to resolve the published 0.0.1a1 packages
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
1 participant
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
Migrates vcspull docs from repo-local Sphinx extensions/theme/config to
the published
gp-sphinxshared documentation platform.What changed
pyproject.toml/uv.lockreplace the repo-managed Sphinx/Furostack with published
gp-sphinx==0.0.1a1andsphinx-argparse-neo==0.0.1a1from PyPI.docs/conf.pyis rewritten aroundmerge_sphinx_config()so sharedtheme settings, fonts, extension defaults, and asset workarounds come
from gp-sphinx.
local argparse helpers, the embedded
sphinx_argparse_neopackage,sphinx_fonts.py, custom docs CSS/JS/templates, and related docs testcoverage.
just mypytarget covers the docs extension modules cleanly.
Test plan
env -u VIRTUAL_ENV just test— 957 passedenv -u VIRTUAL_ENV just ruff— all checks passedenv -u VIRTUAL_ENV just mypy— no issues foundenv -u VIRTUAL_ENV just build-docs— build succeeded, 65 warnings