Skip to main content

Sphinx Theme for ZEIT ONLINE

Project description

============================
Sphinx Theme for ZEIT ONLINE
============================

Based on the fabulous `Read the Docs`_ theme.

.. _`Read the Docs`: https://github.com/rtfd/sphinx_rtd_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``)


=========
Changelog
=========

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.

Source Distribution

sphinx_zon_theme-1.0.0.tar.gz (163.4 kB view hashes)

Uploaded Source

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