Show of github repos and pull requests in your sphinx resume / project.
$ 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', ...]
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-pr:`saltstack/salt/pull/7665`
output:
salt (#7665) Fixed tags for progress events and preload
24 additions(+), 12 deletion(-) 2013-10-08
:github-repo:`saltstack/salt`
output:
salt-states-configs: github
.. 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. |