Metadata-Version: 2.0
Name: sphinxcontrib-github-ribbon
Version: 0.9.0
Summary: Sphinx extension to put a GitHub Ribbon to each HTML pages
Home-page: https://github.com/tk0miya/sphinxcontrib-github_ribbon
Author: Takeshi KOMIYA
Author-email: i.tkomiya@gmail.com
License: BSD
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Requires-Dist: Sphinx (>=0.6)

sphinxcontrib-github_ribbon
===========================

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

.. _GitHub Ribbon: https://github.com/blog/273-github-ribbons

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!


