A clean, three-column Sphinx theme with Bootstrap for the PyData community
The PyData Sphinx Theme is a clean, three-column, Bootstrap-based Sphinx theme created by and for the PyData community. It provides a visually appealing and user-friendly layout for documentation and examples related to PyData projects. The theme is designed to work with Sphinx, a popular documentation tool. It offers both a light and dark theme and is customizable.
To install and use the PyData Sphinx Theme, follow these steps:
Install the theme in your documentation build environment by running the following command:
pip install pydata-sphinx-theme
In the conf.py file of your Sphinx documentation, update the html_theme configuration option to the PyData Sphinx Theme:
html_theme = "pydata_sphinx_theme"
This configures your Sphinx documentation to use the PyData Sphinx Theme as the default theme.
That’s it! You have successfully installed and configured the PyData Sphinx Theme for your Sphinx documentation.
Please note that the theme may not work with the latest major versions of Sphinx, especially if they have been recently released. It is recommended to give the developers some time to work out any bugs and changes when new releases are made.
For more information on contributing to and developing the theme, refer to the contributing section of the documentation.
The PyData Sphinx Theme is a visually appealing and user-friendly theme for Sphinx documentation. It offers a clean design, a three-column layout, and customizable options. With easy installation and usage, it provides an effective tool for creating and presenting documentation for PyData projects. Contributions are welcome, and the theme is actively developed by the PyData community.