How to add to tag list with custom Sphinx role
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 30/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
The issue does not name a source file or test. Start by examining how the custom Sphinx role is defined and how ABlog builds its tag list and tag links. Done means documenting or implementing a way for the role's person name to appear in the tag list and link to its tag page.
Written by the indexing model from the issue text.
Description
Description
I'm using ablog as a lab notebook. I've created a custom Sphinx role, :person:. The argument to the role would be the name of a person. With this role, I want to do two things:
- Add the name to the tag list.
- Make the text a link to the tag.
It wasn't clear to me how to do this and was hoping someone could advise me on how to do this.
- Dominant language
- Python
- Stars
- 196
- Forks
- 64
- PR merge metrics
- No merged PRs in 30d
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.
More from sunpy/ablog
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100