Use "sphinx_copybutton" extension
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 38/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start by locating the Sphinx documentation configuration for the traitsui, envisage, and chaco projects, then check how their documentation currently links to GitHub code. Review how the sphinx_copybutton extension is enabled and run the documentation builds. Done means the affected documentation provides the copy-button alternative without breaking existing GitHub links.
Written by the indexing model from the issue text.
Description
At the moment, in a few projects (traitsui, envisage, chaco), the documentation links to code on GitHub. Alongside linking to GitHub code, it would be nice to provide an alternative e.g. a copy button. We can do this easily using the sphinx_copybutton sphinx extension.
- Dominant language
- Python
- Stars
- 33
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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 enthought/ets
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
-
Difficulty 4/5 3-5 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