docs(deps[gp-sphinx]): Wire sphinx-autodoc-pytest-fixtures and dogfood --doctest-docutils-modules#72
Draft
docs(deps[gp-sphinx]): Wire sphinx-autodoc-pytest-fixtures and dogfood --doctest-docutils-modules#72
Conversation
why: Pull in the fixture-autodoc extension shipped in gp-sphinx 0.0.1a18 so gp-libs' docs stack aligns with libvcs, libtmux, and unihan-etl. Page content is not yet rendered - tracked separately in #71. what: - Add sphinx-autodoc-pytest-fixtures==0.0.1a18 to the dev and docs dependency groups - Load sphinx_autodoc_pytest_fixtures in docs/conf.py extra_extensions= alongside sphinx_autodoc_api_style - Refresh uv.lock
why: gp-libs ships --doctest-docutils-modules but its own test suite used the stdlib --doctest-modules. Switch to the libvcs/libtmux shape so the project exercises its own plugin and any regression shows up locally first. what: - Convert [tool.pytest.ini_options] addopts from a string to a list and swap --doctest-modules for --doctest-docutils-modules - Disable the stdlib doctest plugin via -p no:doctest (belt-and-suspenders with pytest_configure's existing set_blocked call) - Add --reruns=2 (pytest-rerunfailures is already in dev) - Add README.md to testpaths so future doctest blocks in it run automatically; one existing block now runs
why: Surface the dev-tooling and docs-stack changes from this branch in the unreleased 0.0.18 block so readers of the release notes see them when the next version cuts. what: - Add a paragraph under ### Documentation about loading sphinx_autodoc_pytest_fixtures alongside sphinx_autodoc_api_style - Add a paragraph under ### Development about the pytest config dogfooding switch, --reruns=2, and README.md in testpaths
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #72 +/- ##
=======================================
Coverage 73.08% 73.08%
=======================================
Files 14 14
Lines 836 836
=======================================
Hits 611 611
Misses 225 225 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
sphinx-autodoc-pytest-fixtures==0.0.1a18intodev/docsdep groups anddocs/conf.pyextra_extensions=. Matches the libvcs/libtmux/unihan-etl alignment for gp-sphinx 0.0.1a18.--doctest-modulesto gp-libs' own--doctest-docutils-modules, suppress the stdlib doctest plugin via-p no:doctest, add--reruns=2, and addREADME.mdtotestpaths.Draft because
The extension loads but
docs/doctest/pytest.mddoesn't yet contain any.. autofixture::or.. auto-pytest-plugin::directives, so the rendered/doctest/pytest/page is unchanged. Resolving that needs a shipped fixture module or a different page strategy — tracked in #71.Test plan
rm -rf docs/_builduv run ruff check . --fix --show-fixes— All checks passeduv run ruff format .— 15 files left unchangeduv run mypy— no issues in 14 source filesuv run py.test --reruns 0 -vvv— 84 passed (includes newly-exercised README.md doctest)just build-docs— build succeeded, extension loads without warnings