This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

github directives and roles for sphinx

Project Description

Show of github repos and pull requests in your sphinx resume / project.

Installation

$ pip install sphinxcontrib-github

Add sphinxcontrib-github to your extensions in conf.py.

extensions.append('sphinxcontrib.github')

or change:

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

to:

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.

Usage

github pull request role

:github-pr:`saltstack/salt/pull/7665`

output:

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

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

github repo role

:github-repo:`saltstack/salt`

output:

salt-states-configs: github

github repo directive

.. github-repo:: saltstack/salt
    :homepage: http://www.saltstack.org/
    :travis: https://www.travis-ci.org/saltstack/salt/
    :docs: http://salt.readthedocs.org/en/v0.16.4/
    :api: http://salt.readthedocs.org/en/v0.16.4/ref/python-api.html
    :pypi: https://pypi.python.org/pypi/salt

output:

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

python support 2.7
sphinx support >=0.6
Docs http://sphinxcontrib-github.rtfd.org
API http://sphinxcontrib-github.readthedocs.org/en/latest/api.html
Changelog http://sphinxcontrib-github.readthedocs.org/en/latest/history.html
Issues https://github.com/tony/sphinxcontrib-github/issues
Source https://github.com/tony/sphinxcontrib-github
pypi https://pypi.python.org/pypi/sphinxcontrib-github
License BSD.
Release History

Release History

This version
History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinxcontrib-github-0.1.3.tar.gz (6.2 kB) Copy SHA256 Checksum SHA256 Source Nov 16, 2013

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting