Skip to main content

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

Project description

docs Documentation Status
tests
Travis-CI Build Status
demo default, bare
package PyPI Package latest release PyPI Package monthly downloads

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()]

Customization

No extra styling

This theme has some extra styling like different fonts, text shadows for headings, slightly different styling for inline code and code blocks.

To get the original styling Python 3 docs have add this in you conf.py:

html_theme_options = {
    'githuburl': 'https://github.com/ionelmc/sphinx-py3doc-enhanced-theme/',
    'bodyfont': '"Lucida Grande",Arial,sans-serif',
    'headfont': '"Lucida Grande",Arial,sans-serif',
    'codefont': 'monospace,sans-serif',
    'linkcolor': '#0072AA',
    'visitedlinkcolor': '#6363bb',
    'extrastyling': False,
}
pygments_style = 'friendly'

Custom favicon

To have a custom favicon create a theme directory near your conf.py and add this theme.conf in it:

[theme]
inherit = sphinx_py3doc_enhanced_theme

Then create a favicon.png in the static directory.

And then edit your conf.py to have something like this:

import sphinx_py3doc_enhanced_theme
html_theme = "theme"
html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path(), "."]

The final file structure should be like this:

docs
├── conf.py
└── theme
    ├── static
    │   └── favicon.png
    └── theme.conf

A bit of extra css

html_theme_options = {
    'appendcss': 'div.body code.descclassname { display: none }',
}

Changelog

2.4.0 (2016-12-17)

  • Added option to use Google Web Fonts. Contributed by Marius P Isken in #11.

2.3.2 (2015-12-24)

  • Fixed regression in sidebar size when there was no page content. Sidebar has its own height again.

2.3.1 (2015-12-18)

  • Fixed sidebar contents not moving while scrolling at all.

2.3.0 (2015-12-18)

  • Removed use of !important from various places. Contributed by Matthias Geier in #10.

2.2.4 (2015-10-23)

  • Removed awkward bottom padding of paragraphs in table cells.
  • Fix highlight of “p” anchors (that have id and got :target).

2.2.3 (2015-09-13)

  • Fixed display of argument descriptions when there are multiple paragraphs. First paragraph shouldn’t be on a second line.

2.2.2 (2015-09-12)

  • Fixed issues with highlighting a section (via anchor location hash). Previously code blocks would get ugly bar on the left.

2.2.1 (2015-08-21)

  • Fixed positioning of navigation sidebar when displayed in narrow mode (at the bottom). Previously it overlapped the footer.

2.2.0 (2015-08-19)

  • Added the appendcss theme options for quick customization.
  • Added the path setuptools entrypoint so html_theme_path doesn’t need to be set anymore in conf.py.

2.1.1 (2015-07-11)

  • Remove background from reference links when extrastyling is off.

2.1.0 (2015-07-11)

  • Added new theme option extrastyling which can be used to get the original Python 3 docs styling (green code blocks, gray inline code blocks, no text shadows etc)
  • The py.png favicon is renamed to favicon.png.
  • Added some examples for customizing the styling or using a custom favicon.

2.0.2 (2015-07-08)

  • Make inline code blocks bold.

2.0.1 (2015-03-25)

  • Fix inclusion of default.css (now classic.css).

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.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinx_py3doc_enhanced_theme-2.4.0-py2.py3-none-any.whl (36.2 kB) Copy SHA256 hash SHA256 Wheel py2.py3
sphinx-py3doc-enhanced-theme-2.4.0.tar.gz (42.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page