Skip to main content

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, and set the variable github_project_url:

extensions = [...

github_project_url = ""

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib_github_alt-1.2.tar.gz (4.0 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page