sphinx-doc / sphinx-doc/sphinx
Add a value for the `autodoc_class_signature` variable to suppress the constructor signature entirely
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
The autodoc_class_signature variable is useful to indicate whether or not the constructor signature should be part of the class in documentation.
At present it supports two values: "mixed", to include the signature with the class name, and "separated", to print it separately. I would like to have the ability to suppress the signature entirely, given that the constructor (__init__) can be documented separately, in which case the information is redundant.
(In fact, I never understood why the constructor signature was bundled with the class name. Class and constructor are two distinct entities anyway...)
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 tracing how the autodoc_class_signature variable handles the existing "mixed" and "separated" values, then inspect any tests covering those options. Done means a new value suppresses the constructor signature entirely while preserving separately documented init output, with coverage for the new behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100