sphinx-doc / sphinx-doc/sphinx
regression in 2.1.0 on using template for class properties in autodoc
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
In NumPy we use templating for autosummary generation of classes, methods, attributes, and members. These templates live in /_templates/autosummary. Up through v2.1.2, this worked fine. In 2.2.0 class property autosummaries are no longer rendered via the attribute template. The other templates do seem to be used.
See numpy/numpy#14356. I would not wish upon you to try to replicate this, but am willing to try to create a small reproducer if needed. The change seems to be in the changes around generate_autosummary_docs, maybe.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the autosummary templates under src/_templates/autosummary and the generate_autosummary_docs changes mentioned in the report. Compare class property handling between v2.1.2 and v2.2.0, using the NumPy case or a small reproducer if needed. Done means class property autosummaries are rendered through the attribute template again while the other templates continue to work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100