Metadata-Version: 2.0
Name: sphinx-py3doc-enhanced-theme
Version: 2.0.0
Summary: A theme based on the theme of https://docs.python.org/3/ with some responsive enhancements.
Home-page: https://github.com/ionelmc/sphinx-py3doc-enhanced-theme
Author: Ionel Cristian Mărieș
Author-email: contact@ionelmc.ro
License: BSD
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities

=================================================
Enhanced theme based on py3 documentation's theme
=================================================

| |version| |downloads| |wheel| |supported-versions| |supported-implementations|

.. |docs| image:: https://readthedocs.org/projects/sphinx-py3doc-enhanced-theme/badge/?style=flat
    :target: https://readthedocs.org/projects/sphinx-py3doc-enhanced-theme
    :alt: Documentation Status

.. |travis| image:: http://img.shields.io/travis/ionelmc/sphinx-py3doc-enhanced-theme/master.png?style=flat
    :alt: Travis-CI Build Status
    :target: https://travis-ci.org/ionelmc/sphinx-py3doc-enhanced-theme

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/ionelmc/sphinx-py3doc-enhanced-theme?branch=master
    :alt: AppVeyor Build Status
    :target: https://ci.appveyor.com/project/ionelmc/sphinx-py3doc-enhanced-theme

.. |coveralls| image:: http://img.shields.io/coveralls/ionelmc/sphinx-py3doc-enhanced-theme/master.png?style=flat
    :alt: Coverage Status
    :target: https://coveralls.io/r/ionelmc/sphinx-py3doc-enhanced-theme

.. |landscape| image:: https://landscape.io/github/ionelmc/sphinx-py3doc-enhanced-theme/master/landscape.svg?style=flat
    :target: https://landscape.io/github/ionelmc/sphinx-py3doc-enhanced-theme/master
    :alt: Code Quality Status

.. |version| image:: http://img.shields.io/pypi/v/sphinx-py3doc-enhanced-theme.png?style=flat
    :alt: PyPI Package latest release
    :target: https://pypi.python.org/pypi/sphinx-py3doc-enhanced-theme

.. |downloads| image:: http://img.shields.io/pypi/dm/sphinx-py3doc-enhanced-theme.png?style=flat
    :alt: PyPI Package monthly downloads
    :target: https://pypi.python.org/pypi/sphinx-py3doc-enhanced-theme

.. |wheel| image:: https://pypip.in/wheel/sphinx-py3doc-enhanced-theme/badge.png?style=flat
    :alt: PyPI Wheel
    :target: https://pypi.python.org/pypi/sphinx-py3doc-enhanced-theme

.. |supported-versions| image:: https://pypip.in/py_versions/sphinx-py3doc-enhanced-theme/badge.png?style=flat
    :alt: Supported versions
    :target: https://pypi.python.org/pypi/sphinx-py3doc-enhanced-theme

.. |supported-implementations| image:: https://pypip.in/implementation/sphinx-py3doc-enhanced-theme/badge.png?style=flat
    :alt: Supported imlementations
    :target: https://pypi.python.org/pypi/sphinx-py3doc-enhanced-theme

.. |scrutinizer| image:: https://img.shields.io/scrutinizer/g/ionelmc/sphinx-py3doc-enhanced-theme/master.png?style=flat
    :alt: Scrutinizer Status
    :target: https://scrutinizer-ci.com/g/ionelmc/sphinx-py3doc-enhanced-theme/

A theme based on the theme of https://docs.python.org/3/ with some responsive enhancements.

* Free software: BSD license
Installation
============

::

    pip install sphinx_py3doc_enhanced_theme

Add this in your documentation's ``conf.py``::

    import sphinx_py3doc_enhanced_theme
    html_theme = "sphinx_py3doc_enhanced_theme"
    html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()]

Examples
========

* http://python-aspectlib.readthedocs.org/en/latest/
* http://python-manhole.readthedocs.org/en/latest/


Changelog
=========

2.0.0 (2015-03-23)
------------------

* Use HTML5 doctype and force IE into Edge mode.
* Add a embedded flag that removes JS (for building CHM docs).
* Inherit correct theme (default renamed in Sphinx 1.3).

1.2.0 (2015-02-24)
------------------

* Fat-fingered another version. Should had been 1.0.1 ... damn.

1.1.0 (2015-02-24)
------------------

* Match some markup changes in latest Sphinx.

1.0.0 (2015-02-13)
------------------

* Fix depth argument for toctree (contributed by Georg Brandl).

0.1.0 (2014-05-31)
------------------

* First release on PyPI.


