mne-tools / mne-tools/mne-python
consider using sphinx-tags
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Proposed documentation enhancement
https://sphinx-tags.readthedocs.io/en/latest/quickstart.html
we could add .. tags:: BEM, inverse to tutorials/examples, these become links in the rendered docs that go to an auto-generated page saying all pages with tag "BEM" or whatever. There is also an auto-generated "all the tags" page that does what it says on the tin.
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 linked sphinx-tags quickstart and inspect the repository's documentation setup plus tutorial and example pages. Determine how the extension would be enabled and where tags belong; done means the tags render as links and the generated tag index and per-tag pages appear correctly in the documentation build.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100