Metadata-Version: 2.1
Name: sphinx_audeering_theme
Version: 1.1.1
Summary: Sphinx documentation audEERING theme
Home-page: https://github.com/audeering/sphinx-audeering-theme/
Author: Hagen Wierstorf
Author-email: hwierstorf@audeering.com
License: MIT
Project-URL: Documentation, https://audeering.github.io/sphinx-audeering-theme/
Keywords: sphinx,documentation,html
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Documentation
License-File: LICENSE

======================
Sphinx audEERING theme
======================

|tests| |docs| |python-versions| |license| 

Sphinx_ theme to style your documentation project with audEERING colors.

The theme extends the official `readthedocs theme`_ by

* audEERING colors and logo
* support for wide pages, useful for wide tables
* better formatting of tables
* custom styling of figure captions
* make `juptyer-sphinx`_ code cells appear like normal code cells
* custom styling for `copy-button`_ and nbsphinx_

Have a look at the installation_ and usage_ instructions as a starting point.


.. _Sphinx: http://www.sphinx-doc.org/
.. _readthedocs theme: https://sphinx-rtd-theme.readthedocs.io/
.. _juptyer-sphinx: https://jupyter-sphinx.readthedocs.io/
.. _copy-button: https://sphinx-copybutton.readthedocs.io/
.. _nbsphinx: https://nbsphinx.readthedocs.io/
.. _installation: https://audeering.github.io/sphinx-audeering-theme/installation.html
.. _usage: https://audeering.github.io/sphinx-audeering-theme/usage.html

.. badges images and links:
.. |tests| image:: https://github.com/audeering/sphinx-audeering-theme/workflows/Test/badge.svg
    :target: https://github.com/audeering/sphinx-audeering-theme/actions?query=workflow%3ATest
    :alt: Test status
.. |docs| image:: https://img.shields.io/pypi/v/sphinx-audeering-theme?label=docs
    :target: https://audeering.github.io/sphinx-audeering-theme/
    :alt: sphinx-audeering-theme's documentation
.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
    :target: https://github.com/audeering/sphinx-audeering-theme/blob/master/LICENSE
    :alt: sphinx-audeering-theme's MIT license
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-audeering-theme.svg
    :target: https://pypi.org/project/sphinx-audeering-theme/
    :alt: sphinx-audeering-theme's supported Python versions


