Skip to main content

Read the Docs theme for Sphinx

Project description

This is a fork of the official Read the Docs theme for Sphinx. See their theme documentation for more information.

Installation

This theme is distributed on PyPI and can be installed with pip:

$ pip install sphinx_veldus_theme

To use the theme in your Sphinx project, you will need to add the following to your conf.py file:

import sphinx_veldus_theme

extensions = [
    ...
    "sphinx_veldus_theme",
]

html_theme = "sphinx_veldus_theme"

For more information read the full documentation on installing the 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 on configuring the theme.

Contributing

If you would like to help modify or translate the theme, you’ll find more information on contributing in our contributing guide.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-veldus-theme-0.0.1.tar.gz (2.8 MB view hashes)

Uploaded Source

Built Distribution

sphinx_veldus_theme-0.0.1-py2.py3-none-any.whl (2.8 MB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page