======================
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
Raw data
{
"_id": null,
"home_page": "https://github.com/audeering/sphinx-audeering-theme/",
"name": "sphinx-audeering-theme",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sphinx,documentation,html",
"author": "Hagen Wierstorf",
"author_email": "hwierstorf@audeering.com",
"download_url": "https://files.pythonhosted.org/packages/a9/72/6743ce0ffe8dafc477b77bf7361718d89ec2f0a55c2a6238896c699c0cce/sphinx_audeering_theme-1.2.1.tar.gz",
"platform": "any",
"description": "======================\nSphinx audEERING theme\n======================\n\n|tests| |docs| |python-versions| |license| \n\nSphinx_ theme to style your documentation project with audEERING colors.\n\nThe theme extends the official `readthedocs theme`_ by\n\n* audEERING colors and logo\n* support for wide pages, useful for wide tables\n* better formatting of tables\n* custom styling of figure captions\n* make `juptyer-sphinx`_ code cells appear like normal code cells\n* custom styling for `copy-button`_ and nbsphinx_\n\nHave a look at the installation_ and usage_ instructions as a starting point.\n\n\n.. _Sphinx: http://www.sphinx-doc.org/\n.. _readthedocs theme: https://sphinx-rtd-theme.readthedocs.io/\n.. _juptyer-sphinx: https://jupyter-sphinx.readthedocs.io/\n.. _copy-button: https://sphinx-copybutton.readthedocs.io/\n.. _nbsphinx: https://nbsphinx.readthedocs.io/\n.. _installation: https://audeering.github.io/sphinx-audeering-theme/installation.html\n.. _usage: https://audeering.github.io/sphinx-audeering-theme/usage.html\n\n.. badges images and links:\n.. |tests| image:: https://github.com/audeering/sphinx-audeering-theme/workflows/Test/badge.svg\n :target: https://github.com/audeering/sphinx-audeering-theme/actions?query=workflow%3ATest\n :alt: Test status\n.. |docs| image:: https://img.shields.io/pypi/v/sphinx-audeering-theme?label=docs\n \u00a0 \u00a0:target: https://audeering.github.io/sphinx-audeering-theme/\n \u00a0 \u00a0:alt: sphinx-audeering-theme's documentation\n.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg\n \u00a0 \u00a0:target: https://github.com/audeering/sphinx-audeering-theme/blob/master/LICENSE\n \u00a0 \u00a0:alt: sphinx-audeering-theme's MIT license\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/sphinx-audeering-theme.svg\n :target: https://pypi.org/project/sphinx-audeering-theme/\n :alt: sphinx-audeering-theme's supported Python versions\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Sphinx documentation audEERING theme",
"version": "1.2.1",
"split_keywords": [
"sphinx",
"documentation",
"html"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "aa6e073ec993ced628797f959e6cd38a",
"sha256": "b53a031d4f939a9a9031f2d6b268046d35a8618c008c4789da579a3c03b0c918"
},
"downloads": -1,
"filename": "sphinx_audeering_theme-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa6e073ec993ced628797f959e6cd38a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6511510,
"upload_time": "2022-12-01T13:35:32",
"upload_time_iso_8601": "2022-12-01T13:35:32.184946Z",
"url": "https://files.pythonhosted.org/packages/85/3e/775cdd6ffe01106585be45fa18544f69f062fc0cf767a99f65c483433285/sphinx_audeering_theme-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "f2b4861a487ebe653aea6ccf8fc3193b",
"sha256": "acb61b0941b84e4a974e0ab140ab846f82ed37eddd47bd4267cf59663eb41b4b"
},
"downloads": -1,
"filename": "sphinx_audeering_theme-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "f2b4861a487ebe653aea6ccf8fc3193b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6523912,
"upload_time": "2022-12-01T13:35:34",
"upload_time_iso_8601": "2022-12-01T13:35:34.783326Z",
"url": "https://files.pythonhosted.org/packages/a9/72/6743ce0ffe8dafc477b77bf7361718d89ec2f0a55c2a6238896c699c0cce/sphinx_audeering_theme-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-01 13:35:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "audeering",
"github_project": "sphinx-audeering-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": null,
"specs": []
}
],
"lcname": "sphinx-audeering-theme"
}
JSON
