Metadata-Version: 1.1
Name: nextstrain-sphinx-theme
Version: 2020.2
Summary: Nextstrain theme for Sphinx and Read The Docs
Home-page: UNKNOWN
Author: Thomas Sibley
Author-email: tsibley@fredhutch.org
License: MIT
Description: sphinx-nextstrain-theme
        =======================
        
        A `Sphinx theme`_ for Nextstrain's documentation, based on `Read The Docs`_'
        default theme (sphinx_rtd_theme_).
        
        Installation
        ------------
        
        This theme is distributed on PyPI as nextstrain-sphinx-theme_ and can be
        installed with ``pip``:
        
        .. code:: console
        
            $ python3 -m pip install nextstrain-sphinx-theme
        
        To use the theme in your Sphinx project, you will need to add the following to
        your ``conf.py`` file:
        
        .. code:: python
        
            html_theme = "sphinx_rtd_theme"
        
        This theme is based on sphinx_rtd_theme_ and accepts all of the same
        `configuration options`_ settable via ``html_theme_option``.  One additional
        option is supported:
        
        :logo: Boolean determining if the Nextstrain logo should be displayed.
               Defaults to true.
        
        If your project wants to display its own logo, just set Sphinx's ``html_logo``
        to point to the image file in your Sphinx project.
        
        .. code:: python
        
            html_logo = "_static/your-logo.png"
        
        This will automatically take precedence over the default Nextstrain logo
        provided by the theme.
        
        
        .. _Sphinx theme: https://www.sphinx-doc.org/en/master/theming.html
        .. _Read The Docs: https://readthedocs.org
        .. _sphinx_rtd_theme: https://github.com/readthedocs/sphinx_rtd_theme
        .. _nextstrain-sphinx-theme: https://pypi.org/project/nextstrain-sphinx-theme/
        .. _configuration options: https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html
        
Platform: UNKNOWN
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
