Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 1,183 Commits
.devcontainer		.devcontainer
.github		.github
docs		docs
src/pydata_sphinx_theme		src/pydata_sphinx_theme
tests		tests
tools		tools
.git-blame-ignore-revs		.git-blame-ignore-revs
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
.readthedocs.yaml		.readthedocs.yaml
.stylelintrc.json		.stylelintrc.json
.transifex.yaml		.transifex.yaml
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
RELEASE.md		RELEASE.md
babel.cfg		babel.cfg
package-lock.json		package-lock.json
package.json		package.json
pyproject.toml		pyproject.toml
tox.ini		tox.ini
webpack.config.js		webpack.config.js

Repository files navigation

The PyData Sphinx Theme

A clean, three-column, Bootstrap-based Sphinx theme by and for thePyData 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 installand use as follows:

Install thepydata-sphinx-theme in your doc build environment:

pip install pydata-sphinx-theme# orconda install pydata-sphinx-theme --channel conda-forge

Then, in theconf.py of 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, especiallyif they have only recently been released. Please give us a few months oftime to work out any bugs and changes when new releases are made.Seeour contributing documentation for more information.

Contribute to and develop the theme

Contributions are very welcome! Installing the development version, buildingthe example docs and developing theCSS/JS of the theme, etc., is explained inmore detail in the contributing section of the documentation: