Add Methods rubric header even without listing a table
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
When using numpydoc_show_class_members = True in the config, the class methods are listed in a table as follow:
In scikit-learn, we recently switch to pydata-sphinx-theme that has a right-hand side navigation showing the same information. We therefore turn the flag to False. The rendering is looking as:
While we get what we expect (no table listing the methods), we also don't get the rubric title "Methods".
I was wondering if there is still a way to get the rubric name even though we don't want to have the table listed?
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 numpydoc_show_class_members configuration option controls the class-members rubric rendering. Confirm the desired behavior with the issue examples: when the option is False, the “Methods” rubric should remain while the methods table is omitted, and verify the result against the relevant rendering checks.
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
- 35/100