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
1 maintainer
Metadata
1 maintainer
Release files for sphinx-readable-theme 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sphinx-readable-theme-1.3.0.tar.gz | 11.5 kB | Without provenance | Details |
Release files / sphinx-readable-theme-1.3.0.tar.gz
| Download URL | sphinx-readable-theme-1.3.0.tar.gz |
|---|---|
| Size | 11.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f5fe65a2e112cb956b366df41e0fc894ff6b6f0e4a4814fcbff692566db47fc0
|
|
BLAKE2b-256 checksum How to use checksums |
590503ef2bd61c472df2a1485a33bd826a8af7f996d1ed5426b749bc958d0e6a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sphinx-readable-theme 1.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
