Development Status
- 5 - Production/Stable
Programming Language
- Python :: 3
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
- Python :: 3.14
Framework
- Sphinx
- Sphinx :: Theme
License
- OSI Approved :: BSD License
Operating System
- OS Independent
The PyData Sphinx Theme
A clean, three-column, Bootstrap-based Sphinx theme by and for the PyData community.
- :books: Documentation: https://pydata-sphinx-theme.readthedocs.io/en/stable
- :bulb: Examples: https://pydata-sphinx-theme.readthedocs.io/en/stable/examples
- :raised_hands: Contribute: https://pydata-sphinx-theme.readthedocs.io/en/stable/community
- :globe_with_meridians: Translate: https://explore.transifex.com/12rambau/pydata-sphinx-theme/
Installation and usage
The theme is available on PyPI and conda-forge. You can install and use as follows:
-
Install the
pydata-sphinx-themein your doc build environment:pip install pydata-sphinx-theme # or conda install pydata-sphinx-theme --channel conda-forge
-
Then, in the
conf.pyof your sphinx docs, you update thehtml_themeconfiguration 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:
Wheel compatibility matrix
Files in release
sphinx
(<10,>=8.0)
beautifulsoup4
docutils
(!=0.17.0)
Babel
pygments
(>=2.7)
accessible-pygments
typing-extensions