Skip to content

Commit b3cf148

Browse files
committed
docs(CHANGES): add changelog for pytest fixture documentation extension
why: Document the new extension, bug fix, and dev dependency for the upcoming release notes. what: - Add "What's new" entry for sphinx_pytest_fixtures extension listing directives, roles, badges, responsive layout, WCAG compliance, and test count - Add "Bug fixes" entry for session_params docstring fix - Add "Development" entry for types-docutils dev dependency
1 parent a1386c0 commit b3cf148

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

CHANGES

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,34 @@ $ uvx --from 'libtmux' --prerelease allow python
4040
_Notes on the upcoming release will go here._
4141
<!-- END PLACEHOLDER - ADD NEW CHANGELOG ENTRIES BELOW THIS LINE -->
4242

43+
### What's new
44+
45+
#### pytest plugin: fixture reference documentation with autofixture directives (#656)
46+
47+
New Sphinx extension (`docs/_ext/sphinx_pytest_fixtures.py`) renders pytest
48+
fixtures as first-class API documentation with scope/kind/factory badges,
49+
cross-referenced dependencies, and auto-generated usage snippets.
50+
51+
- `.. autofixture::` directive — autodoc-style documenter for individual fixtures
52+
- `.. autofixtures::` directive — bulk discovery and rendering from a module
53+
- `.. autofixture-index::` directive — auto-generated index table with linked
54+
return types (via intersphinx) and parsed RST descriptions
55+
- `:fixture:` cross-reference role with short-name resolution
56+
- Scope, kind, and autouse badges with touch-accessible tooltips (`tabindex`
57+
+ CSS `:focus` popup)
58+
- Responsive layout: mobile metadata stacking, badge font scaling, table scroll
59+
wrapper
60+
- WCAG AA contrast compliance for all badge colors (light and dark mode)
61+
- 109 tests (unit + integration)
62+
63+
### Bug fixes
64+
65+
- Fix `session_params` fixture docstring incorrectly describing return type (#656)
66+
67+
### Development
68+
69+
- Add `types-docutils` to dev dependencies for mypy type checking (#656)
70+
4371
## libtmux 0.55.0 (2026-03-07)
4472

4573
### What's new

0 commit comments

Comments
 (0)