Skip to content

docs: Migrate to gp-sphinx workspace packages#9

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

docs: Migrate to gp-sphinx workspace packages#9
tony merged 4 commits intomainfrom
gp-sphinx

Conversation

@tony
Copy link
Copy Markdown
Member

@tony tony commented Apr 5, 2026

Summary

Migrates libtmux-mcp 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 is rewritten around merge_sphinx_config() so shared theme settings, fonts, extension defaults, and asset workarounds come from gp-sphinx.
  • Removes vendored docs-only files now provided by shared packages: docs/_ext/sphinx_fonts.py, custom docs CSS/JS, and sidebar/page templates.
  • Removes the no-longer-needed sphinx_fonts mypy override.

Test plan

  • just test
  • just ruff
  • just mypy
  • just 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 71.10%. Comparing base (71fc649) to head (be9e992).

Additional details and impacted files
@@           Coverage Diff           @@
##             main       #9   +/-   ##
=======================================
  Coverage   71.10%   71.10%           
=======================================
  Files          20       20           
  Lines        1419     1419           
  Branches      186      186           
=======================================
  Hits         1009     1009           
  Misses        365      365           
  Partials       45       45           

☔ 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
- Update uv.lock
why: sphinx_fonts, templates, static assets, and spa-nav.js are now
     provided by gp-sphinx 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
- Keep docs/_ext/fastmcp_autodoc.py, docs/_static/js/prompt-copy.js,
  docs/_templates/book.html (project-specific)
- Rewrite docs/conf.py to use merge_sphinx_config() and make_linkcode_resolve()
why: sphinx_fonts is no longer a local module.
what:
- Remove sphinx_fonts ignore_missing_imports 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 c822f02 into main Apr 5, 2026
9 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