sphinx-doc / sphinx-doc/sphinx
Have class attribute types in the same line as the name in docstrings
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Is your feature request related to a problem? Please describe.
For class attributes, instead of:
I'd like the type to be in the same line, such as when properties get documented:
Additional context
The displayed screenshot used the furo theme. I was directed here as the creator of furo said it's more of a sphinx thing then a theme issue.
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
No source file or test is named. Start by reproducing the class-attribute and property examples in Sphinx using the furo theme, then trace the documentation output that distinguishes their layouts. Done means class-attribute types appear on the same line as their names, matching the property presentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100