1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
# The PyData Sphinx Theme
[](https://github.com/pydata/pydata-sphinx-theme/blob/main/LICENSE)
[](https://pypi.org/project/pydata-sphinx-theme/)
[](https://anaconda.org/conda-forge/pydata-sphinx-theme)
[](https://github.com/pydata/pydata-sphinx-theme/actions/workflows/CI.yml)
[](https://readthedocs.org/projects/pydata-sphinx-theme/builds/)
A clean, three-column, Bootstrap-based Sphinx theme by and for the [PyData community](https://pydata.org).
- :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/
[](https://pydata-sphinx-theme.readthedocs.io/en/stable)
## 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:
```bash
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:
```python
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](https://pydata-sphinx-theme.readthedocs.io/en/stable/community/practices/versions.html#supported-sphinx-versions) 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:
- [Community and contributing documentation](https://pydata-sphinx-theme.readthedocs.io/en/latest/community/index.html)
|
