Metadata-Version: 2.0
Name: sphinx-kr-theme
Version: 0.1.0
Summary: The third-part package of kennethreitz/kr-sphinx-themes.
Home-page: https://github.com/tonyseek/sphinx-kr-theme
Author: Jiangge Zhang
Author-email: tonyseek@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation

krTheme Sphinx Style
====================

This is the third-part package of Kenneth Reitz's krTheme_. You will not have
to copy the theme files into VCS or register it as submodule anymore.

Installation
------------

.. code-block:: sh

    pip install sphinx-kr-theme

Of course the general usage is putting that into your ``docs/requirements.txt``
then it will be found and installed by the build system such as ReadTheDocs_.

Usage
-----

In your ``conf.py``:

.. code-block:: python

    import sphinx_kr_theme

    html_theme = 'kr'
    html_theme_path = [sphinx_kr_theme.get_html_theme_path()]


.. _krTheme: https://github.com/kennethreitz/kr-sphinx-themes
.. _ReadTheDocs: https://readthedocs.org

.. |Build Status| image:: https://travis-ci.org/tonyseek/sphinx-kr-theme.svg?branch=master,develop
   :target: https://travis-ci.org/tonyseek/sphinx-kr-theme
   :alt: Build Status
.. |Wheel Status| image:: https://pypip.in/wheel/sphinx-kr-theme/badge.svg
   :target: https://pypi.python.org/pypi/sphinx-kr-theme
   :alt: Wheel Status
.. |PyPI Version| image:: https://img.shields.io/pypi/v/sphinx-kr-theme.svg
   :target: https://pypi.python.org/pypi/sphinx-kr-theme
   :alt: PyPI Version
.. |PyPI Downloads| image:: https://img.shields.io/pypi/dm/sphinx-kr-theme.svg
   :target: https://pypi.python.org/pypi/sphinx-kr-theme
   :alt: Downloads


