mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2025-02-25 18:55:21 -06:00
Sphinx theme for readthedocs.org
a6ed75f0d5
* Do not overflow object cross references * Rebuild theme for https://github.com/readthedocs/sphinx_rtd_theme/pull/1369 * Adds a demo for the regression * Mock sphinx-automodapi for now, but we can use it soon * we can replace sphinx-automodapi demo entirely with autosummary since it uses this under the hood * We need a python 2.7 compliant test module. Add a short-term workaround until this is removed in 2.0. * Add comment about the terrible tox workaround * Use a less hacky way of conditional autosummary in demo API docs - Use `only` directive for conditional reST instead - Drops 1.6 from our text matrix, it was deprecated in 1.0 release. There were issues with the conditional directive only on 1.6 for some reason. Co-authored-by: Benjamin Bach <benjamin@overtag.dk> Co-authored-by: Anthony Johnson <aj@ohess.org> |
||
|---|---|---|
| .circleci | ||
| .github | ||
| .tx | ||
| bin | ||
| docs | ||
| sphinx_rtd_theme | ||
| src | ||
| tests | ||
| .gitattributes | ||
| .gitignore | ||
| .readthedocs.yml | ||
| Apache-License-2.0.txt | ||
| babel.cfg | ||
| docker-compose.yaml | ||
| docker-entrypoint.sh | ||
| Dockerfile | ||
| LICENSE | ||
| Makefile | ||
| 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/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