Link to GitHub issues, pull requests, commits and users from Sphinx docs.
Project description
Link to GitHub issues, pull requests, commits and users for a particular project.
To use this extension, add it to the extensions list in conf.py, and set the variable github_project_url:
extensions = [...
'sphinxcontrib_github_alt',
]
github_project_url = "https://github.com/ipython/ipython"
Then use these roles in your documentation:
* :ghissue:`12` - link to issue #12
* :ghpull:`35` - link to pull request #35
* :ghcommit:`3a1cb54` - link to commit
* :ghuser:`ipython` - link to a user or organisation
It’s called ‘alt’ because sphinxcontrib-github already exists. IPython & Jupyter projects have been using the syntax defined in this extension for some time before we made it into its own package, so we didn’t want to switch to sphinxcontrib-github.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sphinxcontrib_github_alt-1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfd7584d559bb89a1dde3b418fea3b5b8e601e1f50459873635256b5d1712af5 |
|
MD5 | 0e9f2ee320af2bc879adc9f4b96f0f7c |
|
BLAKE2b-256 | b8d52880f4f441f3b46f264cb031d9e7135714b5060c895c8a6458051002c41a |
Close
Hashes for sphinxcontrib_github_alt-1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cdd1f61090e9ca1f317283dc85b311d788864d7e41baa479882c9fc914b43641 |
|
MD5 | 4588fc0495bfb8cd34aa0818edc60baa |
|
BLAKE2b-256 | 7012d9b6bf8093906108017f3cdbecae3e2b3b4963c5112b28f0cd482b433182 |