Skip to main content

sphinxcontrib-github_ribbon is a Sphinx extension to put a GitHub Ribbon to each HTML pages.

Usage

Append this extension in conf.py:

extensions = ['sphinxcontrib.github_ribbon']

And update settings:

github_ribbon_repo

The location of your repository. By default, “sphinx-doc/sphinx”.

github_ribbon_position = (“left” | “right”)

The position of ribbon. By default, “right”.

github_ribbon_color = (“red” | “green” | “darkblue” | “orange” | “gray” | “white”)

The color of ribbont. By default, “red”.

Special Thanks

Members of Sphinx-users.jp!

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_ribbon-0.9.0.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinxcontrib_github_ribbon-0.9.0-py2.py3-none-any.whl (5.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file sphinxcontrib-github_ribbon-0.9.0.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-github_ribbon-0.9.0.tar.gz
Algorithm Hash digest
SHA256 594294ec7bda92cdb20c9cd63a2041b5392f96cb89e211b2237f7274ae8dad90
MD5 4bf2ff8469fb2e3b54f3264fbd76853e
BLAKE2b-256 dceeb4ea40a07d9203c0a8d70923fbd47c1fa72014cd4f42c4496bd3c0762771

See more details on using hashes here.

File details

Details for the file sphinxcontrib_github_ribbon-0.9.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_github_ribbon-0.9.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f1aab243d7e3a328a6399b75e4076d28f14c65af933bf580c92920fa8ee6c847
MD5 32484b1c83ab130f276678d735474680
BLAKE2b-256 79c28cb198db29af16607c94e86bf71e9d622d4a23c88d209a9c5e317aa6352b

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.9.0 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page