Skip to main content

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

Project description

=================================================
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.

Project details


Download files

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

Source Distribution

sphinx-py3doc-enhanced-theme-2.0.0.tar.gz (35.5 kB view details)

Uploaded Source

Built Distribution

sphinx_py3doc_enhanced_theme-2.0.0-py2.py3-none-any.whl (34.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file sphinx-py3doc-enhanced-theme-2.0.0.tar.gz.

File metadata

File hashes

Hashes for sphinx-py3doc-enhanced-theme-2.0.0.tar.gz
Algorithm Hash digest
SHA256 00bc68b3dac1ea7e0be9bdc8cdb66230284ad2610ef16634f2a0149289aef69f
MD5 69557f210f0d835bb4d11b80de179956
BLAKE2b-256 1df817f05029ef7bfb5717d448ef5c9508b4e79916d3f0dd17bd32949e617f3d

See more details on using hashes here.

File details

Details for the file sphinx_py3doc_enhanced_theme-2.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_py3doc_enhanced_theme-2.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9f041e47f2bc508c7ba90066847132ec05d27eb7aeb59154455684a3d538ad7c
MD5 598a9c3488b2190fb88818061e125839
BLAKE2b-256 2cfc8e5ca30d8e3eee34f9e4171c814ffbdad2845ce59a5d3ba4a8ef529d4550

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page