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/
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/
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
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
FAQs
Read the Docs theme for Sphinx
We found that sphinx-rtd-theme demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.