Skip to main content

STScI Branded Sphinx theme

Project description


This is a Sphinx theme for packages maintained by the Space Telescope Sciences Institute (STScI).


This theme inherits from sphinx-rtd-theme; however, the CSS styling has been altered for easier reading on a variety of platforms and browsers.


You can apply this theme to your current documents by installing the latest release from PyPI:

pip install stsci-rtd-theme

If you need the most up-to-date version of the master branch, you can install directly from GitHub:

pip install

If you wish to modify the source code, you should clone the repository locally and install editable (-e):

git clone
cd stsci_rtd_theme
pip install -e .

Sphinx configuration

If you haven't already created your Sphinx documentation, you can start sphinx with sphinx-quickstart and follow the guided steps. When you are finished, add these lines to your docs/ file:

# docs/

import stsci_rtd_theme

html_theme = 'stsci_rtd_theme'
html_theme_path = [stsci_rtd_theme.get_html_theme_path()]

ReadTheDocs configuration

Add the following lines to your docs/ file:

# docs/

import sphinx
import os
from packaging.version import Version

def setup(app):

extensions = [

on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if on_rtd:
elif Version(sphinx.__version__) < Version('1.4'):

Finally, make sure to include stsci-rtd-theme to the docs extra, or alternatively add stsci-rtd-theme to a rtd-requirements.txt file. Then, in .readthedocs.yaml, include the following (depending on which of the two methods are used to define the stsci-rtd-theme dependency):

# .readthedocs.yaml
  - method: pip
    path: .
      - docs
# .readthedocs.yaml
  - requirements: .rtd-requirements.txt
  - method: pip
    path: .

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

stsci_rtd_theme-1.0.1.tar.gz (584.2 kB view hashes)

Uploaded Source

Built Distribution

stsci_rtd_theme-1.0.1-py3-none-any.whl (393.8 kB view hashes)

Uploaded 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