Skip to main content

Sphinx theme for Enthought products

Project description

Sphinx theme for Enthought projects, derived from the Scipy theme.

Installation

Install this as a normal Python package. The theme files are in the package data.

In your project’s conf.py file, do the following:

import enthought_sphinx_theme
html_theme_path = [enthought_sphinx_theme.theme_path]
html_theme = 'enthought'

Theme options

The theme takes the followin options in the html_theme_options configuration variable:

  • rootlinks

    List of tuples (url, link_name) to show in the beginning of the breadcrumb list on the top left. You can override it by defining an edit_link block in searchbox.html.

  • sidebar

    One of "left", "right", "none". Defines where the sidebar should appear.

  • navigation_links

    True or False. Whether to display “next”, “prev”, “index”, etc. links.

  • use_default_logo

    True or False. Whether to use the default Enthought logo in the sidebar. If the html_logo configuration parameter is non-empty, it will override this. Set this to False and html_logo to empty only if you want no logo at all.

  • use_default_favicon

    True or False. Whether to use the default Enthought logo as the favicon. If the html_favicon configuration parameter is non-empty, it will override this. Set this to False and html_favicon to empty only if you want no favicon at all.

The following blocks are defined:

  • layout.html:header

    Block at the top of the page, for logo etc.

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

enthought_sphinx_theme-0.6.tar.gz (594.0 kB view details)

Uploaded Source

File details

Details for the file enthought_sphinx_theme-0.6.tar.gz.

File metadata

  • Download URL: enthought_sphinx_theme-0.6.tar.gz
  • Upload date:
  • Size: 594.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.2 pkginfo/1.4.2 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.8.0 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for enthought_sphinx_theme-0.6.tar.gz
Algorithm Hash digest
SHA256 a63ffa0783b3293640871e1d8bab67235447db2044f852553cc95a8788009ebf
MD5 6872be85994f574c1accb93d270e8a52
BLAKE2b-256 e46caf45d10ce61843324b2438509dd540c5009206a51dc29dfdaf0de3f2fa03

See more details on using hashes here.

Provenance

Supported by

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