Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Sphinx Readable Theme

Project Description

A clean and readable Sphinx theme with focus on autodoc – documentation from docstrings.

Inspired by flask-sphinx-themes.

Installation and setup

Install from PyPI:

$ pip install sphinx-readable-theme

And add this to your conf.py:

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

Release History

Release History

This version
History Node

1.3.0

History Node

1.2.0

History Node

1.1.0

History Node

1.0.0

History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinx-readable-theme-1.3.0.tar.gz (11.5 kB) Copy SHA256 Checksum SHA256 Source Mar 27, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting