Add a Sphinx extension to document cached properties of slots classes#1519

Closed

clayote wants to merge 32 commits into

python-attrs:mainfrom

clayote:sphinx-attr-getter-ext

Commits on Mar 12, 2026

Add a test for the @cached_property hack
clayote
committed
Write a Sphinx extension to document `@cached_property` on slots classes
clayote
committed
Add news snippet
clayote
committed
Fix pyproject.toml
clayote
committed
Add a test for Sphinx's autodoc `:members:`
clayote
committed
Add a weird hack to make Sphinx pretend slots for cached props aren't there
clayote
committed
Add `__eq__` and `__ne__` to `_TupleProxy`
clayote
committed
Write docstrings for tests
clayote
committed
Add docstring to sphinx_cached_property.py
clayote
committed
"Implement" `_TupleProxy.__hash__`
clayote
committed
Make the `tests` dependency group depend on the `docs` one
clayote
committed
Add `test_tuple_proxy`
clayote
committed
Delete `_TupleProxy.__ne__`
clayote
committed
Add equality assertion to `test_tuple_proxy`
clayote
committed
Put some stuff in the tuples for `test_tuple_proxy`
clayote
committed
Test hashes in `test_tuple_proxy`
clayote
committed
Document `sphinx_cached_property` in `how-does-it-work.md`
clayote
committed
Remove the :mod: role from "Sphinx" in how-does-it-work.md
clayote
committed
Improve module docstring in `sphinx_cached_property.py`
clayote
committed
Update changelog.d/1519.change.md

clayote
and
webknjaz
committed
Remove `@need_sphinx` from test_slots.py
clayote
committed
Use pytest's `tmp_path` fixture for Sphinx tests
clayote
committed
Make Sphinx tests more elegant with `read_text`
clayote
committed
Use shutil to make Sphinx tests more elegant in test_slots.py
clayote
committed
Remove the now-pointless import guard around Sphinx in test_slots.py
clayote
committed
Report attrs version in `attrs.sphinx_cached_property`
clayote
committed
Add docstrings to `sphinx_cached_property.py`
clayote
committed
Include Sphinx &c in uv.lock
clayote
committed
Fix `_TupleProxy` docstring
clayote
committed
Put the Sphinx test data in its own subdir
clayote
committed
Add type hints to `sphinx_cached_property.py`
clayote
committed
Fix Python 3.9-incompatible union syntax
clayote
committed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add a Sphinx extension to document cached properties of slots classes#1519

Add a Sphinx extension to document cached properties of slots classes#1519
clayote wants to merge 32 commits into
python-attrs:mainfrom
clayote:sphinx-attr-getter-ext

Commits on Mar 12, 2026

Add a test for the @cached_property hack

Write a Sphinx extension to document `@cached_property` on slots classes

Add news snippet

Fix pyproject.toml

Add a test for Sphinx's autodoc `:members:`

Add a weird hack to make Sphinx pretend slots for cached props aren't there

Add `eq` and `ne` to `_TupleProxy`

Write docstrings for tests

Add docstring to sphinx_cached_property.py

"Implement" `_TupleProxy.hash`

Make the `tests` dependency group depend on the `docs` one

Add `test_tuple_proxy`

Delete `_TupleProxy.ne`

Add equality assertion to `test_tuple_proxy`

Put some stuff in the tuples for `test_tuple_proxy`

Test hashes in `test_tuple_proxy`

Document `sphinx_cached_property` in `how-does-it-work.md`

Remove the :mod: role from "Sphinx" in how-does-it-work.md

Improve module docstring in `sphinx_cached_property.py`

Update changelog.d/1519.change.md

Remove `@need_sphinx` from test_slots.py

Use pytest's `tmp_path` fixture for Sphinx tests

Make Sphinx tests more elegant with `read_text`

Use shutil to make Sphinx tests more elegant in test_slots.py

Remove the now-pointless import guard around Sphinx in test_slots.py

Report attrs version in `attrs.sphinx_cached_property`

Add docstrings to `sphinx_cached_property.py`

Include Sphinx &c in uv.lock

Fix `_TupleProxy` docstring

Put the Sphinx test data in its own subdir

Add type hints to `sphinx_cached_property.py`

Fix Python 3.9-incompatible union syntax