mne-tools / mne-tools/mne-python
ENH: Website API class-methods in "On this page"(right dock)
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Describe the new feature or enhancement
For the documentation of classes in the API on the Website it may be easier to navigate if their methods were outlined in the right sidebar ("On this page").
Implementation
I am not sure how to implement this. Maybe some change of the configuration of sphinx.autodoc? Or would it need changes on how the pydata-sphinx-theme handles the API?
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 API documentation configuration for the Website and investigate how sphinx.autodoc generates class pages and how pydata-sphinx-theme builds the “On this page” sidebar. Determine whether the change belongs in project configuration or the theme, then verify that documented class methods appear in the right sidebar.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100