Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1033 +/- ##
==========================================
+ Coverage 81.02% 81.96% +0.93%
==========================================
Files 28 28
Lines 2630 2545 -85
Branches 492 485 -7
==========================================
- Hits 2131 2086 -45
+ Misses 368 328 -40
Partials 131 131 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
why: Consolidate docs dependencies into the gp-sphinx shared platform,
resolving from PyPI now that 0.0.1a0 is published.
what:
- Remove sphinx<9, furo, sphinx-autodoc-typehints, sphinx-inline-tabs,
sphinxext-opengraph, sphinx-copybutton, sphinxext-rediraffe,
sphinx-design, myst-parser, linkify-it-py from dev/docs groups
- Add gp-sphinx==0.0.1a0 and sphinx-argparse-neo==0.0.1a0
- Remove cli_usage_lexer, argparse_lexer, argparse_roles from mypy overrides
- Update uv.lock to resolve from PyPI
why: sphinx-argparse-neo and sphinx-fonts are now provided as PyPI packages
via gp-sphinx; bundled copies in docs/_ext/ are no longer needed.
what:
- Delete docs/_ext/sphinx_fonts.py, sphinx_argparse_neo/, argparse_exemplar.py,
argparse_lexer.py, argparse_roles.py, cli_usage_lexer.py
- Delete docs/_static/js/spa-nav.js (now bundled in sphinx-gptheme)
- Migrate docs/conf.py to use merge_sphinx_config() from gp_sphinx
- Update tests/docs/_ext/ imports to reference installed packages
why: All removed files are now bundled in sphinx-gptheme and loaded
automatically, making local copies pure maintenance debt.
what:
- Delete argparse-highlight.css — identical to theme bundled version
- Delete custom.css — replaced by tmuxp.css (12-line project-specific
aspect-ratio overrides only; all generic CSS now from theme)
- Delete _templates/page.html — identical to theme version; mask-icon
moved to theme_options.mask_icon instead of hardcoded in template
- Delete _templates/sidebar/brand.html — identical to theme version
- Delete _templates/sidebar/projects.html — identical to theme version
- Add docs/_static/css/tmuxp.css with only tmuxp-specific image
aspect-ratio rules (tmuxp-demo, tmuxp-shell, tmuxp-dev-screenshot)
- Update conf.py: css/custom.css → css/tmuxp.css,
add theme_options={"mask_icon": "/_static/img/tmuxp.svg"}
- Update uv.lock to gp-sphinx init-2 commit c2fe249
(theme: move mask-icon outside show_meta_app_icon_tags guard)
why: After rebasing onto master, trunk's unicode-range/multi-subset tests reference _unicode_range, _UNICODE_RANGES, and subset-aware _on_builder_inited which existed in the local docs/_ext/sphinx_fonts.py but are not yet in the packaged sphinx_fonts from gp-sphinx. what: - Remove 4 _unicode_range / _UNICODE_RANGES unit tests - Remove 2 _on_builder_inited tests for multi-subset and unicode_range support
why: After gp-sphinx migration, these modules are only imported in docs/ and tests/docs/ which are excluded from mypy scanning. what: - Remove aafigure, sphinx_argparse_neo, sphinx_fonts, docutils, pygments from mypy overrides
why: Testing gp-sphinx 0.0.1a0 packages in live docs environment
…packages
why: sphinx-fonts and sphinx-argparse-neo are now standalone PyPI packages
(0.0.1a0). Their test suites live upstream; tmuxp should not duplicate
or maintain them.
what:
- Remove tests/docs/_ext/test_sphinx_fonts.py
- Remove tests/docs/_ext/sphinx_argparse_neo/ (7 test files)
- Remove tests/docs/_ext/test_argparse_{exemplar,lexer,roles}.py
- Remove tests/docs/_ext/test_cli_usage_lexer.py
- Remove tests/docs/__init__.py and supporting conftest/init files
why: mypy exclude was added specifically to silence type errors in the
upstream extension tests. With tests/docs/ removed, the exclusion
is unnecessary.
what:
- Remove exclude = ["tests/docs/"] from [tool.mypy]
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 tmuxp docs from individually-managed Sphinx extensions and manual
conf.pyboilerplate to the gp-sphinx shared documentation platform.This PR depends on git-pull/gp-sphinx#init-2 — the workspace restructuring branch that splits gp-sphinx into 4 separate packages. Not ready to merge until gp-sphinx publishes those packages to PyPI.
What changed
pyproject.toml— Replace 9 individual sphinx deps (furo,sphinx-autodoc-typehints,sphinx-inline-tabs,sphinxext-opengraph,sphinx-copybutton,sphinxext-rediraffe,sphinx-design,myst-parser,linkify-it-py) withgp-sphinx+sphinx-argparse-neo. Uses[tool.uv.sources]pointing to local editable gp-sphinx packages during development.docs/conf.py— Rewrites 293-line manual config to a 46-linemerge_sphinx_config()call;make_linkcode_resolve()replaces 50-line manuallinkcode_resolve(); theme switches fromfurotosphinx-gptheme(Furo child theme); spa-nav.js/tabs.js workarounds handled by gp-sphinx.docs/_ext/— Removessphinx_fonts.py,argparse_exemplar.py,argparse_lexer.py,argparse_roles.py,cli_usage_lexer.py, and the embeddedsphinx_argparse_neo/directory (~4,400 lines) — all now provided by published packages.docs/_static/js/spa-nav.js— Removed; bundled insphinx-gpthemetheme statics.tests/docs/_ext/— Updates imports from old_ext/paths tosphinx_argparse_neo.*package paths; removessys.pathmanipulation from conftest; fixes version assertion intest_sphinx_fonts.py.Bugs fixed upstream in gp-sphinx (init-2)
During the migration the following issues were found and fixed in gp-sphinx:
sphinx_argparse_neo/exemplar.py—from argparse_roles import register_roles→from sphinx_argparse_neo.roles import register_roles(wouldModuleNotFoundErrorwhen installed as a package)gp_sphinx/config.py— Removed deadASSETS_DIRconstant (noassets/dir;spa-nav.jslives insphinx-gptheme)gp_sphinx/config.py— Addedhtml_static_path = ["_static"]andtemplates_path = ["_templates"]defaults (without these,docs/_static/was silently skipped — logos, custom CSS, favicons all 404'd)gp_sphinx/defaults.py— AddedDEFAULT_TOC_OBJECT_ENTRIES_SHOW_PARENTS = "hide"constantTest plan
uv run pytest— 1154 passed, 2 skippeduv run ruff check .— no issuesuv run mypy— no issuesjust build-docs— build succeeded (101 pre-existing autodoc/cross-ref warnings, unrelated to this change)