Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 1,507 Commits
.circleci		.circleci
.github		.github
.tx		.tx
bin		bin
docs		docs
sphinx_rtd_theme		sphinx_rtd_theme
src		src
tests		tests
.gitattributes		.gitattributes
.gitignore		.gitignore
.readthedocs.yml		.readthedocs.yml
Apache-License-2.0.txt		Apache-License-2.0.txt
Dockerfile		Dockerfile
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
Makefile		Makefile
OFL-License.txt		OFL-License.txt
README.rst		README.rst
babel.cfg		babel.cfg
docker-compose.yaml		docker-compose.yaml
docker-entrypoint.sh		docker-entrypoint.sh
package-lock.json		package-lock.json
package.json		package.json
pytest.ini		pytest.ini
setup.cfg		setup.cfg
setup.py		setup.py
tox.ini		tox.ini
webpack.common.js		webpack.common.js
webpack.dev.js		webpack.dev.js
webpack.prod.js		webpack.prod.js

Repository files navigation

Read the Docs Sphinx Theme

ThisSphinx theme was designed to provide a great reader experience fordocumentation users on both desktop and mobile devices. This theme is usedprimarily onRead the Docs but can work with any Sphinx project. You can finda working demo of the theme in thetheme documentation

Installation

This theme is distributed onPyPI and can be installed withpip:

$pip install sphinx-rtd-theme

To use the theme in your Sphinx project, you will need to edityourconf.py file'shtml_theme setting:

html_theme="sphinx_rtd_theme"

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 onconfiguring the theme.