Add links to GitHub issues and Pull Requests.
sphinx_toolbox.issues by adding the following
extensions variable in your
extensions = [ ... 'sphinx_toolbox.issues', ]
For more information see https://www.sphinx-doc.org/en/master/usage/extensions#third-party-extensions .
Role which shows a link to the given issue on GitHub.
If the issue exists, the link has a tooltip that shows the title of the issue.
You can also reference an issue in a different repository by adding the repository name inside
Role which shows a link to the given pull request on GitHub.
If the pull requests exists, the link has a tooltip that shows the title of the pull requests.
You can also reference a pull request in a different repository by adding the repository name inside
Changed in version 2.4.0:
pull now show the repository name
when the name differs from that configured in
Changed in version 2.4.0: These directives are also available in the
The only difference between the
is in the URL. GitHub uses the same numbering scheme for issues and
pull requests, and automatically redirects to the pull request if
the user tries to navigate to an issue with that same number.
HTTP requests to obtain issue/pull request titles are cached for four hours.
To clear the cache manually, run:
python3 -m sphinx_toolbox
Changed in version 2.4.0: The following moved to
New in version 1.0.0.
Sphinx) – The Sphinx application.
- Return type