Skip to main content

github directives and roles for sphinx

Project description

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-hypernode.com/pypi/salt

output:

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.0.tar.gz (5.0 kB view details)

Uploaded Source

File details

Details for the file sphinxcontrib-github-0.1.0.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-github-0.1.0.tar.gz
Algorithm Hash digest
SHA256 71863aef5c2028a6d2c86076a50d9b6a204890c7b472f1084f25043b9a2063c0
MD5 a0e081c4af3e40d7df7ed3131844fde7
BLAKE2b-256 9012a05b9cbc7a6c3dd05a25fc06fa91766ea132128e1772d5be9f97fc7538e2

See more details on using hashes here.

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