tswast/pydata-sphinx-theme
A clean, three-column Sphinx theme with Bootstrap for the PyData community
The PyData Sphinx Theme
A clean, three-column, Bootstrap-based Sphinx theme by and for the PyData community.
- 📚 Documentation: https://pydata-sphinx-theme.readthedocs.io/en/stable
- 💡 Examples: https://pydata-sphinx-theme.readthedocs.io/en/stable/examples
- 🙌 Contribute: https://pydata-sphinx-theme.readthedocs.io/en/stable/community
- 🌐 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_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: