Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

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.

Download files

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

Files for sphinxcontrib_github_alt, version 1.2
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_github_alt-1.2-py2.py3-none-any.whl (4.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size sphinxcontrib_github_alt-1.2.tar.gz (4.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page