**************************
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://travis-ci.org/readthedocs/sphinx_rtd_theme.svg?branch=master
:target: https://travis-ci.org/readthedocs/sphinx_rtd_theme
:alt: Build Status
.. 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 add the following to
your ``conf.py`` file:
.. code:: python
import sphinx_rtd_theme
extensions = [
...
"sphinx_rtd_theme",
]
html_theme = "sphinx_rtd_theme"
For more information read the full 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
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-rtd-eth-theme",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Dave Snider, Read the Docs, Inc. & contributors",
"author_email": "dev@readthedocs.org",
"download_url": "https://files.pythonhosted.org/packages/a4/d8/e113954a40328ab51fad5aa9eb0666f2a7c3fbe1fbaf1f13b9000ce4f483/sphinx_rtd_eth_theme-0.5.2.tar.gz",
"platform": null,
"description": "**************************\nRead the Docs Sphinx Theme\n**************************\n\n.. image:: https://img.shields.io/pypi/v/sphinx_rtd_theme.svg\n :target: https://pypi.python.org/pypi/sphinx_rtd_theme\n :alt: Pypi Version\n.. image:: https://travis-ci.org/readthedocs/sphinx_rtd_theme.svg?branch=master\n :target: https://travis-ci.org/readthedocs/sphinx_rtd_theme\n :alt: Build Status\n.. image:: https://img.shields.io/pypi/l/sphinx_rtd_theme.svg\n :target: https://pypi.python.org/pypi/sphinx_rtd_theme/\n :alt: License\n.. image:: https://readthedocs.org/projects/sphinx-rtd-theme/badge/?version=latest\n :target: http://sphinx-rtd-theme.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\nThis Sphinx_ theme was designed to provide a great reader experience for\ndocumentation users on both desktop and mobile devices. This theme is used\nprimarily on `Read the Docs`_ but can work with any Sphinx project. You can find\na working demo of the theme in the `theme documentation`_\n\n.. _Sphinx: http://www.sphinx-doc.org\n.. _Read the Docs: http://www.readthedocs.org\n.. _theme documentation: https://sphinx-rtd-theme.readthedocs.io/en/latest/\n\nInstallation\n============\n\nThis theme is distributed on PyPI_ and can be installed with ``pip``:\n\n.. code:: console\n\n $ pip install sphinx-rtd-theme\n\nTo use the theme in your Sphinx project, you will need to add the following to\nyour ``conf.py`` file:\n\n.. code:: python\n\n import sphinx_rtd_theme\n\n extensions = [\n ...\n \"sphinx_rtd_theme\",\n ]\n\n html_theme = \"sphinx_rtd_theme\"\n\nFor more information read the full documentation on `installing the theme`_\n\n.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme\n.. _installing the theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html\n\nConfiguration\n=============\n\nThis theme is highly customizable on both the page level and on a global level.\nTo see all the possible configuration options, read the documentation on\n`configuring the theme`_.\n\n.. _configuring the theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html\n\nContributing\n============\n\nIf you would like to help modify or translate the theme, you'll find more\ninformation on contributing in our `contributing guide`_.\n\n.. _contributing guide: https://sphinx-rtd-theme.readthedocs.io/en/latest/contributing.html\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Read the Docs theme for Sphinx",
"version": "0.5.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a4d8e113954a40328ab51fad5aa9eb0666f2a7c3fbe1fbaf1f13b9000ce4f483",
"md5": "fffb70cde19b337d71714ba1882f88b4",
"sha256": "eac1adbf146825f397122773d4d25afada3c4212051d54676df0f41d58f21ad2"
},
"downloads": -1,
"filename": "sphinx_rtd_eth_theme-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "fffb70cde19b337d71714ba1882f88b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 718398,
"upload_time": "2025-01-07T12:58:11",
"upload_time_iso_8601": "2025-01-07T12:58:11.755508Z",
"url": "https://files.pythonhosted.org/packages/a4/d8/e113954a40328ab51fad5aa9eb0666f2a7c3fbe1fbaf1f13b9000ce4f483/sphinx_rtd_eth_theme-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-07 12:58:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinx-rtd-eth-theme"
}
JSON