Metadata-Version: 2.1
Name: sphinx-rtd-theme-github-versions
Version: 1.1
Summary: Sphinx readthedocs theme with support for documentation versions from github.io
Home-page: https://github.com/dls-controls/sphinx_rtd_theme_github_versions
Author: Tom Cobb
Author-email: tom.cobb@diamond.ac.uk
License: Apache License 2.0
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
Requires-Dist: sphinx-rtd-theme
Provides-Extra: dev
Requires-Dist: black (==21.9b0) ; extra == 'dev'
Requires-Dist: isort (>5.0) ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: flake8-isort ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: types-docutils ; extra == 'dev'

sphinx_rtd_theme_github_versions
================================

|code_ci| |docs_ci| |coverage| |pypi_version| |license|

This theme inherits from sphinx_rtd_theme_ and adds an entry in the sidebar
listing all versions of the documentation on github.io for the current repo

============== ==============================================================
PyPI           ``pip install sphinx_rtd_theme_github_versions``
Source code    https://github.com/dls-controls/sphinx_rtd_theme_github_versions
Documentation  https://dls-controls.github.io/sphinx_rtd_theme_github_versions
Releases       https://github.com/dls-controls/sphinx_rtd_theme_github_versions/releases
============== ==============================================================

|screenshot|

.. |code_ci| image:: https://github.com/dls-controls/sphinx_rtd_theme_github_versions/workflows/Code%20CI/badge.svg?branch=master
    :target: https://github.com/dls-controls/sphinx_rtd_theme_github_versions/actions?query=workflow%3A%22Code+CI%22
    :alt: Code CI

.. |docs_ci| image:: https://github.com/dls-controls/sphinx_rtd_theme_github_versions/workflows/Docs%20CI/badge.svg?branch=master
    :target: https://github.com/dls-controls/sphinx_rtd_theme_github_versions/actions?query=workflow%3A%22Docs+CI%22
    :alt: Docs CI

.. |coverage| image:: https://codecov.io/gh/dls-controls/sphinx_rtd_theme_github_versions/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/dls-controls/sphinx_rtd_theme_github_versions
    :alt: Test Coverage

.. |pypi_version| image:: https://img.shields.io/pypi/v/sphinx_rtd_theme_github_versions.svg
    :target: https://pypi.org/project/sphinx_rtd_theme_github_versions
    :alt: Latest PyPI version

.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
    :target: https://opensource.org/licenses/Apache-2.0
    :alt: Apache License

.. _sphinx_rtd_theme: https://pypi.org/project/sphinx-rtd-theme/

..
    Anything below this line is used when viewing README.rst and will be replaced
    when included in index.rst

.. |screenshot| image:: https://raw.githubusercontent.com/dls-controls/sphinx_rtd_theme_github_versions/master/docs/images/screenshot.png

See https://dls-controls.github.io/sphinx_rtd_theme_github_versions for more detailed documentation.


