Metadata-Version: 1.1
Name: sphinx-zon-theme
Version: 1.4.0
Summary: Sphinx Theme for ZEIT ONLINE
Home-page: https://github.com/zeitonline/sphinx_zon_theme/
Author: Wolfgang Schnerring <wolfgang.schnerring@zeit.de>
Author-email: wolfgang.schnerring@zeit.de
License: MIT
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``)
        * 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.
        
        .. _`sphinx_elasticsearch`: https://pypi.org/project/sphinx_elasticsearch
        
        
        =========
        Changelog
        =========
        
        1.4.0 (2020-10-16)
        ==================
        
        - Make compatible with Sphinx-2, update sphinx_rtd_theme to 0.5.0
        
        
        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)
        ==================
        
        - Update default URL to https://docs.zeit.de
        
        
        1.1.0 (2018-12-10)
        ==================
        
        - Use sphinx_elasticsearch for searching.
        
        
        1.0.0 (2018-09-27)
        ==================
        
        - Initial release.
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
