Skip to main content

Bootstrap-based Sphinx theme from the PyData community

Project description

The PyData Sphinx Theme

License badge PyPI version badge conda-forge version badge GitHub Workflow test status badge Read the Docs build status badge

A clean, three-column, Bootstrap-based Sphinx theme by and for the PyData community.

PyData theme - Configure the search position demo image showcasing both the light and dark theme in a single image.

Installation and usage

The theme is available on PyPI and conda-forge. You can install and use as follows:

  • Install the pydata-sphinx-theme in your doc build environment:

    pip install pydata-sphinx-theme
    # or
    conda install pydata-sphinx-theme --channel conda-forge
  • Then, in the of your sphinx docs, you update the html_theme configuration option:

    html_theme = "pydata_sphinx_theme"

And that's it!

Note This theme may not work with the latest major versions of Sphinx, especially if they have only recently been released. Please give us a few months of time to work out any bugs and changes when new releases are made. See our contributing documentation for more information.

Contribute to and develop the theme

Contributions are very welcome! Installing the development version, building the example docs and developing the CSS/JS of the theme, etc., is explained in more detail in the contributing section of the documentation:

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

pydata_sphinx_theme-0.15.3.tar.gz (2.4 MB view hashes)

Uploaded Source

Built Distribution

pydata_sphinx_theme-0.15.3-py3-none-any.whl (4.6 MB 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