安装

备注

Each pydata-sphinx-theme release has a minimum required Sphinx version, which should be automatically handled by your package installer. It is also tested against newer versions of Sphinx that were available prior to that release of the pydata-sphinx-theme package. If you run into issues when trying to use a more recent version of Sphinx, please open an issue here: https://github.com/pydata/pydata-sphinx-theme/issues

主题在 PyPI 和 conda-forge 上可用，因此可以安装：

$ pip install pydata-sphinx-theme

$ conda install pydata-sphinx-theme --channel conda-forge

然后，在你的 sphinx 文档的 conf.py 中，更新 html_theme 配置选项：

html_theme = "pydata_sphinx_theme"

备注

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.

Development version

如果你想要跟踪主题的开发版本，你可以从 git repo 安装它：

$ pip install git+https://github.com/pydata/pydata-sphinx-theme.git@main

或者在 conda 环境的 yml 文件中，你可以添加：

- pip:
  - git+https://github.com/pydata/pydata-sphinx-theme.git@main