Sphinx Readable Theme
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