Conversation
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
why: Consolidate duplicated Sphinx docs infrastructure from 14+ repos into a single shared package. This commit establishes the full project skeleton conforming to ~/work/python/ and ~/work/cihai/ conventions. what: - pyproject.toml: hatchling build, src layout, uv, ruff, mypy, pytest - src/gp_sphinx/: config.py (merge_sphinx_config API), defaults.py, sphinx_fonts.py (bundled from docs/_ext/), assets/spa-nav.js - tests/: 16 functional tests + 7 doctests (23 total, all passing) - docs/: conf.py dogfooding gp_sphinx, project/ contributing docs, justfile, templates, custom.css, manifest.json - CI: tests.yml (Python 3.10-3.14, ruff, mypy, pytest, codecov, PyPI Trusted Publisher), docs.yml (S3/CloudFront/Cloudflare) - Tooling: justfile, .tmuxp.yaml, .tool-versions, .prettierrc - Convention files: CLAUDE.md symlink, .github/contributing.md, CHANGES, README.md
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
2 participants
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
gp-sphinx, the shared Sphinx documentation platform for git-pull projectsSource package (
src/gp_sphinx/)config.py—merge_sphinx_config()API: builds complete Sphinx conf namespace from shared defaults with per-project overridesdefaults.py— Single source of truth for 14 shared extensions, Furo theme options, MyST config, IBM Plex font config, sidebar layout, copybutton/autodoc settingssphinx_fonts.py— Bundled Fontsource CDN font extension (was duplicated asdocs/_ext/sphinx_fonts.pyacross all repos)assets/spa-nav.js— SPA navigation workaround (also previously duplicated)Tooling & CI
pyproject.toml— hatchling build, src layout, uv, ruff, mypy strict, pytest with--doctest-modulesjustfile+docs/justfile— Task runner (test, lint, format, docs groups).tmuxp.yaml— Dev session with watch-mypy, watch-test, sphinx-autobuild.github/workflows/tests.yml— Python 3.10–3.14 matrix, ruff, mypy, pytest, codecov, PyPI Trusted Publisher release.github/workflows/docs.yml— S3/CloudFront/Cloudflare deploymentDocumentation
docs/conf.py— Dogfoodsgp_sphinxitself viamerge_sphinx_config()conf.pyexamplesdocs/project/— Contributing, code style, releasing guidesResearch notes
notes/2026-03-28/— Multi-model brainstorm output: project overview, Furo deep analysis, Phase 0 specexec()→ flat namespace dict,globals().update()is the only injection interfaceTest plan
uv run ruff check .— all checks passeduv run ruff format . --check— all files formatteduv run mypy src tests— no issues (9 files)uv run py.test— 23 passed (16 unit tests + 7 doctests)cd docs && just html— Sphinx build (requires network for font download)