mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2025-02-25 18:55:21 -06:00
Sphinx theme for readthedocs.org
207ae966ec
This finally defines our supported browsers and dependencies publicly, and communicates our next several versions that we have planned so far. This information is starting with 1.0.0, but I did try to capture some historical information as well. |
||
|---|---|---|
| .circleci | ||
| .github | ||
| .tx | ||
| bin | ||
| docs | ||
| sphinx_rtd_theme | ||
| src | ||
| tests | ||
| .gitattributes | ||
| .gitignore | ||
| .readthedocs.yml | ||
| Apache-License-2.0.txt | ||
| babel.cfg | ||
| LICENSE | ||
| MANIFEST.in | ||
| OFL-License.txt | ||
| package-lock.json | ||
| package.json | ||
| README.rst | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
| webpack.common.js | ||
| webpack.dev.js | ||
| webpack.prod.js | ||
**************************
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/latest/
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"
For more information, including a full example with localized strings enabled,
read the documentation on `installing the theme`_.
.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme
.. _installing the theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html
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/latest/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/latest/contributing.html