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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50e8493c1362c9203179ab46c2265554d027f22ba71650283a517f76781a9a87 |
|
MD5 | 6e8b239b13ee076c518446a101aa2f43 |
|
BLAKE2b-256 | 34a72ae524c3d223b7b4761c40c35d204b8f54882fff7d068df3cbf0d8881bff |
Close
Hashes for sphinxcontrib_github_alt-1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e585b03b71076fb1c26977b927617ed15207263e489d246355b354fb9ced0a50 |
|
MD5 | f45d382044619287fa03c4c698bb19ed |
|
BLAKE2b-256 | 6bbdbdbbf059881e3038fe324421e52daed1ee03c58e79d8d5b23ef00c12389d |