sphinx-doc / sphinx-doc/sphinx
Undocumented members include by automodule when only :members: specified.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
It appears there's been a regression at some point and with v4.2.0, undocumented members are being included by automodule.
How to Reproduce
Here's the source:
https://raw.githubusercontent.com/simplistix/sybil/8ba210ff3ac33a50dc3611a9153c67dae05e6919/docs/api.rst
Here's a link to the rendering:
https://sybil.readthedocs.io/en/latest/api.html#sybil.parsers.capture.DocumentReverseIterator
(although I may have to work around it...)
Expected behavior
Undocumented members such as DocumentReverseIterator and SybilFailure should not be included, unless :undoc-members: is specified.
Your project
https://github.com/simplistix/sybil/
Screenshots
No response
OS
linux
Python version
3.7
Sphinx version
4.2.0
Sphinx extensions
No response
Extra tools
No response
Additional context
No response
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 by reading the referenced docs/api.rst and reproduce the automodule output with Sphinx 4.2.0. Compare the documented members with sybil/parsers/capture.py and sybil/example.py, especially DocumentReverseIterator and SybilFailure. Done means undocumented members are excluded when only :members: is specified and included only when :undoc-members: is present.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100