Metadata-Version: 2.4
Name: sphinx-readable-theme
Version: 1.3.0
Summary: Sphinx Readable Theme
Home-page: https://github.com/ignacysokolowski/sphinx-readable-theme
Author: Ignacy Sokolowski
Author-email: ignacy.sokolowski@gmail.com
License: Copyright (c) 2013 Ignacy Sokołowski
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Documentation
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: summary

=====================
Sphinx Readable Theme
=====================

A clean and readable `Sphinx <http://sphinx-doc.org>`_ theme with focus on
`autodoc` -- documentation from docstrings.

Inspired by
`flask-sphinx-themes <https://github.com/mitsuhiko/flask-sphinx-themes>`_.


Installation and setup
======================


Install from PyPI::

    $ pip install sphinx-readable-theme

And add this to your ``conf.py``:

.. code-block:: python

    import sphinx_readable_theme

    html_theme_path = [sphinx_readable_theme.get_html_theme_path()]
    html_theme = 'readable'


Documentation and examples
==========================

Documentation with examples is available at
https://sphinx-readable-theme.readthedocs.org


License
=======

Sphinx Readable Theme is licensed under the MIT license.


Changelog
=========

Version 1.3.0
-------------

* Fixed padding for search results -- thanks, Matt Bennett!

Version 1.2.0
-------------

* Added styles for ``<code>`` tag, which replaced ``<tt>`` in Sphinx 1.3

Version 1.1.0
-------------

* Fixed footnote tables width -- thanks, Nick Zaccardi!

Version 1.0.0
-------------

* Fixed continuation lines in long ordered and unordered list items
* Fixed references in Autodoc example

Version 0.1.0
-------------

First release
