Skip to main content

github directives and roles for sphinx

Project description


$ pip install sphinxcontrib-github

Add sphinxcontrib-github to your extensions in


or change:

extensions = ['sphinx.ext.intersphinx', ...]


extensions = ['sphinx.ext.intersphinx', 'sphinxcontrib.github', ...]

Setting up API access

First use will require entering your github username and password. Read the source for logging in. It will create an API key with github and save an api id and api key for future usage in your projects directory.

Add .github.auth to your .gitignore.


github pull request role



salt (#7665) Fixed tags for progress events and preload

24 additions(+), 12 deletion(-) 2013-10-08

github repo role



salt-states-configs: github

github repo directive

.. github-repo:: saltstack/salt


github - travis - docs - api - pypi - homepage - 2296 watchers - 813 forks

Project details

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-0.1.2.tar.gz (5.9 kB view hashes)

Uploaded Source

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