安装

备注

每个 pydata-sphinx-theme 版本都有最低要求的 Sphinx 版本，这通常由您的包安装工具自动处理。它也在发布前针对当时可用的较新 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