You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
116 lines
4.3 KiB
116 lines
4.3 KiB
Metadata-Version: 2.1
|
|
Name: sphinx-rtd-theme
|
|
Version: 2.0.0
|
|
Summary: Read the Docs theme for Sphinx
|
|
Home-page: https://github.com/readthedocs/sphinx_rtd_theme
|
|
Author: Dave Snider, Read the Docs, Inc. & contributors
|
|
Author-email: dev@readthedocs.org
|
|
License: MIT
|
|
Project-URL: Homepage, https://sphinx-rtd-theme.readthedocs.io/
|
|
Project-URL: Source Code, https://github.com/readthedocs/sphinx_rtd_theme
|
|
Project-URL: Issue Tracker, https://github.com/readthedocs/sphinx_rtd_theme/issues
|
|
Platform: UNKNOWN
|
|
Classifier: Framework :: Sphinx
|
|
Classifier: Framework :: Sphinx :: Theme
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Classifier: Environment :: Console
|
|
Classifier: Environment :: Web Environment
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3 :: Only
|
|
Classifier: Programming Language :: Python :: 3.6
|
|
Classifier: Programming Language :: Python :: 3.7
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Programming Language :: Python :: 3.10
|
|
Classifier: Programming Language :: Python :: 3.11
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Topic :: Documentation
|
|
Classifier: Topic :: Software Development :: Documentation
|
|
Requires-Python: >=3.6
|
|
Requires-Dist: sphinx (<8,>=5)
|
|
Requires-Dist: docutils (<0.21)
|
|
Requires-Dist: sphinxcontrib-jquery (<5,>=4)
|
|
Provides-Extra: dev
|
|
Requires-Dist: transifex-client ; extra == 'dev'
|
|
Requires-Dist: sphinxcontrib-httpdomain ; extra == 'dev'
|
|
Requires-Dist: bump2version ; extra == 'dev'
|
|
Requires-Dist: wheel ; extra == 'dev'
|
|
|
|
**************************
|
|
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
|
|
|
|
|
|
|