mne-tools / mne-tools/mne-python
Investigate whether available Sphinx directives can be dynamically determined
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
FYI extensions can add their own (and we could even create some) but it's okay to start with this list. For example, sphinx-gallery has a .. minigallery:: directive. (I wonder if there is some way to query Sphinx to get the list of directives it knows about... doesn't have to be here, though)
Originally posted by @larsoner in https://github.com/mne-tools/mne-python/pull/14184#discussion_r3833010305
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 locating the existing list of supported Sphinx directives and read how it is used. Check whether Sphinx exposes a way to query registered directives, including extension-provided directives such as sphinx-gallery's .. minigallery::. Done means documenting the result and, if practical, replacing or extending the current list with a verified approach.
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
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100