https://github.com/audeering/sphinx-audeering-theme
Sphinx theme from audEERING
https://github.com/audeering/sphinx-audeering-theme
documentation html sphinx-doc
Last synced: 6 months ago
JSON representation
Sphinx theme from audEERING
- Host: GitHub
- URL: https://github.com/audeering/sphinx-audeering-theme
- Owner: audeering
- License: other
- Created: 2020-10-19T08:51:31.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T20:17:02.000Z (over 1 year ago)
- Last Synced: 2025-04-16T03:08:24.693Z (about 1 year ago)
- Topics: documentation, html, sphinx-doc
- Language: HTML
- Homepage: https://audeering.github.io/sphinx-audeering-theme/
- Size: 6.62 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
======================
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