Metadata-Version: 2.4
Name: sphinx_audeering_theme
Version: 1.4.4
Summary: Sphinx documentation audEERING theme
Author-email: Hagen Wierstorf <hwierstorf@audeering.com>
License: MIT License
        
        Copyright (c) 2020- audEERING GmbH and Contributors
        Copyright (c) 2013-2018 Dave Snider, Read the Docs, Inc. & contributors
        
        Authors:
            Hagen Wierstorf
            Dave Snider
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: repository, https://github.com/audeering/sphinx-audeering-theme/
Project-URL: documentation, https://audeering.github.io/sphinx-audeering-theme/
Keywords: sphinx,documentation,html
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
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.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: sphinx>=6.0.0
Dynamic: license-file

======================
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/main/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
