style(deps[docs]): Integrate sphinx-autodoc-api-style, bump gp-sphinx packages to 0.0.1a5#10
Draft
style(deps[docs]): Integrate sphinx-autodoc-api-style, bump gp-sphinx packages to 0.0.1a5#10
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #10 +/- ##
=======================================
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. 🚀 New features to boost your workflow:
|
…i-style why: Add type and modifier badges to autodoc entries. what: - Add sphinx_autodoc_api_style to extra_extensions in docs/conf.py
…to 0.0.1a5 why: Align docs dependencies with latest gp-sphinx workspace releases. what: - Pin sphinx-autodoc-api-style and bump gp-sphinx packages to 0.0.1a5 - Regenerate uv.lock
why: Preview published docs from the feature branch before merge. what: - Add api-styling to docs workflow push branches
…rces why: Consume the new extension from gp-sphinx; optional path overrides for a sibling gp-sphinx clone during development. what: - dev/docs dependency on sphinx-autodoc-fastmcp - tool.uv.sources for gp-sphinx, sphinx-autodoc-api-style, sphinx-autodoc-fastmcp - mypy override for sphinx_autodoc_fastmcp - uv.lock
why: Drop the inlined fastmcp_autodoc extension in favor of the gp-sphinx package; configure tool modules, area map, and section badges. what: - extra_extensions and fastmcp_* settings in docs/conf.py - remove docs/_ext/fastmcp_autodoc.py; drop _ext from sys.path
why: Lockfile reflects transitive editable deps from gp-sphinx packages. what: - uv.lock updates for sphinx-autodoc-api-style and sphinx-autodoc-fastmcp requires-dist
why: Pydantic's BaseModel uses Markdown-style [text][ref] cross-refs in docstrings, but autodoc processes them as RST, yielding citation-ref rendering instead of hyperlinks. what: - autodoc-process-docstring hook rewrites [`Name`][pkg.Name] to :any: roles - pyproject.toml: add fastmcp_autodoc to mypy ignore_missing_imports
why: Align dev docs dependencies with gp-sphinx 0.0.1a6 on PyPI. what: - Bump gp-sphinx ecosystem pins in pyproject.toml - Regenerate uv.lock
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.
Pins gp-sphinx and sphinx-autodoc-api-style to 0.0.1a5; enables API style extension in docs.