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 conf.py 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.16.1.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

pydata_sphinx_theme-0.16.1-py3-none-any.whl (6.7 MB view details)

Uploaded Python 3

File details

Details for the file pydata_sphinx_theme-0.16.1.tar.gz.

File metadata

  • Download URL: pydata_sphinx_theme-0.16.1.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for pydata_sphinx_theme-0.16.1.tar.gz
Algorithm Hash digest
SHA256 a08b7f0b7f70387219dc659bff0893a7554d5eb39b59d3b8ef37b8401b7642d7
MD5 e629ab8013637be343c9f1836863c232
BLAKE2b-256 0020bb50f9de3a6de69e6abd6b087b52fa2418a0418b19597601605f855ad044

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydata_sphinx_theme-0.16.1.tar.gz:

Publisher: publish.yml on pydata/pydata-sphinx-theme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pydata_sphinx_theme-0.16.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pydata_sphinx_theme-0.16.1-py3-none-any.whl
Algorithm Hash digest
SHA256 225331e8ac4b32682c18fcac5a57a6f717c4e632cea5dd0e247b55155faeccde
MD5 54683f51ee62eb4edb1e21f13af7fdd4
BLAKE2b-256 e20d8ba33fa83a7dcde13eb3c1c2a0c1cc29950a048bfed6d9b0d8b6bd710b4c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pydata_sphinx_theme-0.16.1-py3-none-any.whl:

Publisher: publish.yml on pydata/pydata-sphinx-theme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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