**************************
Read the Docs Sphinx Theme
**************************
.. image:: https://img.shields.io/pypi/v/sphinx_rtd_theme.svg
:target: https://pypi.python.org/pypi/sphinx_rtd_theme
:alt: Pypi Version
.. image:: https://circleci.com/gh/readthedocs/sphinx_rtd_theme.svg?style=svg
:alt: Build Status
:target: https://circleci.com/gh/readthedocs/sphinx_rtd_theme
.. image:: https://img.shields.io/pypi/l/sphinx_rtd_theme.svg
:target: https://pypi.python.org/pypi/sphinx_rtd_theme/
:alt: License
.. image:: https://readthedocs.org/projects/sphinx-rtd-theme/badge/?version=latest
:target: http://sphinx-rtd-theme.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
This Sphinx_ theme was designed to provide a great reader experience for
documentation users on both desktop and mobile devices. This theme is used
primarily on `Read the Docs`_ but can work with any Sphinx project. You can find
a working demo of the theme in the `theme documentation`_
.. _Sphinx: http://www.sphinx-doc.org
.. _Read the Docs: http://www.readthedocs.org
.. _theme documentation: https://sphinx-rtd-theme.readthedocs.io/en/stable/
Installation
============
This theme is distributed on PyPI_ and can be installed with ``pip``:
.. code:: console
$ pip install sphinx-rtd-theme
To use the theme in your Sphinx project, you will need to edit
your ``conf.py`` file's ``html_theme`` setting:
.. code:: python
html_theme = "sphinx_rtd_theme"
.. admonition:: See also:
`Supported browsers`_
Officially supported and tested browser/operating system combinations
`Supported dependencies`_
Supported versions of Python, Sphinx, and other dependencies.
`Example documentation`_
A full example of this theme output, with localized strings enabled.
.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme
.. _Supported browsers: https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#supported-browsers
.. _Supported dependencies: https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#supported-dependencies
.. _Example documentation: https://sphinx-rtd-theme.readthedocs.io/en/stable/
Configuration
=============
This theme is highly customizable on both the page level and on a global level.
To see all the possible configuration options, read the documentation on
`configuring the theme`_.
.. _configuring the theme: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html
Contributing
============
If you would like to help modify or translate the theme, you'll find more
information on contributing in our `contributing guide`_.
.. _contributing guide: https://sphinx-rtd-theme.readthedocs.io/en/stable/contributing.html
Raw data
{
"_id": null,
"home_page": "https://github.com/readthedocs/sphinx_rtd_theme",
"name": "sphinx-rtd-theme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Dave Snider, Read the Docs, Inc. & contributors",
"author_email": "dev@readthedocs.org",
"download_url": "https://files.pythonhosted.org/packages/91/44/c97faec644d29a5ceddd3020ae2edffa69e7d00054a8c7a6021e82f20335/sphinx_rtd_theme-3.0.2.tar.gz",
"platform": null,
"description": "**************************\nRead the Docs Sphinx Theme\n**************************\n\n.. image:: https://img.shields.io/pypi/v/sphinx_rtd_theme.svg\n :target: https://pypi.python.org/pypi/sphinx_rtd_theme\n :alt: Pypi Version\n.. image:: https://circleci.com/gh/readthedocs/sphinx_rtd_theme.svg?style=svg\n :alt: Build Status\n :target: https://circleci.com/gh/readthedocs/sphinx_rtd_theme\n.. image:: https://img.shields.io/pypi/l/sphinx_rtd_theme.svg\n :target: https://pypi.python.org/pypi/sphinx_rtd_theme/\n :alt: License\n.. image:: https://readthedocs.org/projects/sphinx-rtd-theme/badge/?version=latest\n :target: http://sphinx-rtd-theme.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\nThis Sphinx_ theme was designed to provide a great reader experience for\ndocumentation users on both desktop and mobile devices. This theme is used\nprimarily on `Read the Docs`_ but can work with any Sphinx project. You can find\na working demo of the theme in the `theme documentation`_\n\n.. _Sphinx: http://www.sphinx-doc.org\n.. _Read the Docs: http://www.readthedocs.org\n.. _theme documentation: https://sphinx-rtd-theme.readthedocs.io/en/stable/\n\nInstallation\n============\n\nThis theme is distributed on PyPI_ and can be installed with ``pip``:\n\n.. code:: console\n\n $ pip install sphinx-rtd-theme\n\nTo use the theme in your Sphinx project, you will need to edit\nyour ``conf.py`` file's ``html_theme`` setting:\n\n.. code:: python\n\n html_theme = \"sphinx_rtd_theme\"\n\n.. admonition:: See also:\n\n `Supported browsers`_\n Officially supported and tested browser/operating system combinations\n\n `Supported dependencies`_\n Supported versions of Python, Sphinx, and other dependencies.\n\n `Example documentation`_\n A full example of this theme output, with localized strings enabled.\n\n.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme\n.. _Supported browsers: https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#supported-browsers\n.. _Supported dependencies: https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#supported-dependencies\n.. _Example documentation: https://sphinx-rtd-theme.readthedocs.io/en/stable/\n\nConfiguration\n=============\n\nThis theme is highly customizable on both the page level and on a global level.\nTo see all the possible configuration options, read the documentation on\n`configuring the theme`_.\n\n.. _configuring the theme: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html\n\nContributing\n============\n\nIf you would like to help modify or translate the theme, you'll find more\ninformation on contributing in our `contributing guide`_.\n\n.. _contributing guide: https://sphinx-rtd-theme.readthedocs.io/en/stable/contributing.html\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Read the Docs theme for Sphinx",
"version": "3.0.2",
"project_urls": {
"Homepage": "https://sphinx-rtd-theme.readthedocs.io/",
"Issue Tracker": "https://github.com/readthedocs/sphinx_rtd_theme/issues",
"Source Code": "https://github.com/readthedocs/sphinx_rtd_theme"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "857746e3bac77b82b4df5bb5b61f2de98637724f246b4966cfc34bc5895d852a",
"md5": "263b3f1b4a7615988a8b7a5c3f9e73ea",
"sha256": "422ccc750c3a3a311de4ae327e82affdaf59eb695ba4936538552f3b00f4ee13"
},
"downloads": -1,
"filename": "sphinx_rtd_theme-3.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "263b3f1b4a7615988a8b7a5c3f9e73ea",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 7655561,
"upload_time": "2024-11-13T11:06:02",
"upload_time_iso_8601": "2024-11-13T11:06:02.094116Z",
"url": "https://files.pythonhosted.org/packages/85/77/46e3bac77b82b4df5bb5b61f2de98637724f246b4966cfc34bc5895d852a/sphinx_rtd_theme-3.0.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9144c97faec644d29a5ceddd3020ae2edffa69e7d00054a8c7a6021e82f20335",
"md5": "b26e7ff8c3a90817bbc20fb76c530e00",
"sha256": "b7457bc25dda723b20b086a670b9953c859eab60a2a03ee8eb2bb23e176e5f85"
},
"downloads": -1,
"filename": "sphinx_rtd_theme-3.0.2.tar.gz",
"has_sig": false,
"md5_digest": "b26e7ff8c3a90817bbc20fb76c530e00",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7620463,
"upload_time": "2024-11-13T11:06:04",
"upload_time_iso_8601": "2024-11-13T11:06:04.545540Z",
"url": "https://files.pythonhosted.org/packages/91/44/c97faec644d29a5ceddd3020ae2edffa69e7d00054a8c7a6021e82f20335/sphinx_rtd_theme-3.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 11:06:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "readthedocs",
"github_project": "sphinx_rtd_theme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "sphinx-rtd-theme"
}
JSON
