github directives and roles for sphinx
Project description
Show of github repos and pull requests in your sphinx resume / project.
Installation
$ pip install sphinxcontrib-githubAdd 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/saltoutput:
github - travis - docs - api - pypi - homepage - 2296 watchers - 813 forks
python support |
2.7 |
sphinx support |
>=0.6 |
Docs |
|
API |
http://sphinxcontrib-github.readthedocs.org/en/latest/api.html |
Changelog |
http://sphinxcontrib-github.readthedocs.org/en/latest/history.html |
Issues |
|
Source |
|
pypi |
|
License |
BSD. |
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for sphinxcontrib-github-0.1.3.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ae8cc9d0a9fb99b90a236ea71f306644032e856956054f171a890c32f8d82d6d |
|
| MD5 | 931cef00b0e8146718a1ac816eb48972 |
|
| BLAKE2b-256 | b203fdf5b89ecddab89b9a11d52e08b2398d8f8558bb8389707ab40ee6ab9368 |
