Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #345 +/- ##
==========================================
+ Coverage 89.64% 91.01% +1.37%
==========================================
Files 32 8 -24
Lines 3311 345 -2966
==========================================
- Hits 2968 314 -2654
+ Misses 343 31 -312 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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/ 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: Source doctests need a stable way to clear ambient NO_COLOR state during color-mode examples. what: - add a root conftest with an autouse doctest_namespace fixture for monkeypatch - ensure doctest environment changes are undone after each example run
why: The color helper intentionally lets NO_COLOR override ALWAYS, but the examples still asserted the opposite under ambient NO_COLOR. what: - clear NO_COLOR before the ALWAYS example so it matches the documented success case - add an explicit doctest showing that NO_COLOR disables colors even in ALWAYS mode
why: The gp-sphinx docs stack moved to v0.0.1a1 and cihai-cli needs 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
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 cihai-cli docs from repo-local Sphinx theme/config/assets to the published
gp-sphinxshared documentation platform.What changed
pyproject.toml/uv.lockswitch the docs stack togp-sphinx==0.0.1a1andsphinx-argparse-neo==0.0.1a1from PyPI.docs/conf.pyis already rewritten aroundmerge_sphinx_config()so theme settings, shared extensions, fonts, and JS workarounds come from gp-sphinx instead of local boilerplate.monkeypatchand fixes the_colors.pyexamples so they match the actualNO_COLORprecedence contract.Test plan
just testjust ruffjust mypyjust build-docs