安装

注意

每个 pydata-sphinx-theme 版本都有一个最小必需的 Sphinx 版本，这应该由您的软件包安装程序自动处理。 它还针对该 pydata-sphinx-theme 包版本发布之前可用的更新版本的 Sphinx 进行了测试。 如果您在尝试使用更新版本的 Sphinx 时遇到问题，请在此处打开一个问题：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"

注意

此主题可能无法与最新的主要版本的 Sphinx 兼容，尤其是如果它们只是最近发布的。 请给我们几个月的时间来解决新版本发布时出现的任何错误和更改。

开发版本

如果您想跟踪该主题的开发版本，您可以从 git 仓库中安装它

$ 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