Skip to main content

Sphinx Theme for ZEIT ONLINE

Project description

Sphinx Theme for ZEIT ONLINE

Based on the fabulous Read the Docs theme.

Usage

Install the package, e.g. pip install sphinx_zon_theme, and then set html_theme = 'sphinx_zon_theme' in your Sphinx conf.py.

Features

  • Automatically uses the ZON logo.

  • Adds an “edit this page” link to the sidebar. To customize how this link is created, you can set the following:

    html_theme_options = {
        'editme_link': (
            'https://github.com/zeitonline/{project}/edit/master/{page}')
    }
    
    (This is the default value, it supports two variables, project is taken

    directly from conf.py, and page evaluates to path/to/current/page.suffix)

  • Supports (multi-project) search using sphinx_elasticsearch. Configure like this (default values are shown here):

    html_theme_options = {
        'elasticsearch_host': 'http://docs.zeit.de/elasticsearch',
        'elasticsearch_index': 'docs',
        # For creating links to search result items
        'public_url_root': 'http://docs.zeit.de/'
    }
    

    To disable and use the built-in Sphinx search, set elasticsearch_host to None.

  • Adds a “like” button (iframe) at the bottom of each page. To disable, set like_iframe_src to None.

Changelog

1.3.2 (2020-01-08)

  • Hide empty table heads with CSS

1.3.1 (2019-12-11)

  • Fix rst syntax for pypi upload

1.3.0 (2019-12-11)

  • Style tables a little more nicely

1.2.0 (2019-04-05)

  • Add a “like” button to the bottom of each page

1.1.1 (2018-12-14)

1.1.0 (2018-12-10)

  • Use sphinx_elasticsearch for searching.

1.0.0 (2018-09-27)

  • Initial release.

Project details


Download files

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

Files for sphinx-zon-theme, version 1.3.2
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_zon_theme-1.3.2.tar.gz (252.3 kB) File type Source Python version None Upload date Hashes View hashes

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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page