mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2025-02-25 18:55:21 -06:00
05807985d6
Some people might add the example code to the top of the file, in which case `alabaster` will overwrite later. Also, localization is important but not so important for people using this for the first time. My concern is that many people end up with Alabaster on RTD deployments after Sphinx 4 made it the default. Co-authored-by: Aaron Carlisle <carlisle.b3d@gmail.com>
65 lines
2.3 KiB
ReStructuredText
65 lines
2.3 KiB
ReStructuredText
**************************
|
|
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
|