基于Bootstrap的来自PyData社区的Sphinx主题
项目描述
PyData Sphinx主题
这是一个由PyData社区为PyData社区设计的干净、三栏式的基于Bootstrap的Sphinx主题。
- :books: 文档: https://pydata.sphinx-doc.cn/en/stable
- :bulb: 示例: https://pydata.sphinx-doc.cn/en/stable/examples
- :raised_hands: 贡献: https://pydata.sphinx-doc.cn/en/stable/community
- :globe_with_meridians: 翻译: https://explore.transifex.com/12rambau/pydata-sphinx-theme/
安装和使用
该主题可在PyPI和conda-forge上找到。您可以通过以下方式安装和使用:
-
在您的文档构建环境中安装
pydata-sphinx-theme
pip install pydata-sphinx-theme # or conda install pydata-sphinx-theme --channel conda-forge
-
然后,在您的sphinx文档的
conf.py
中,您更新html_theme
配置选项html_theme = "pydata_sphinx_theme"
就完成了!
[!NOTE] 该主题可能不适用于Sphinx的最新主要版本,特别是如果它们最近才发布。请在新版本发布后给我们几个月的时间来修复任何错误和更改。有关更多信息,请参阅我们的贡献文档。
为该主题做出贡献和发展
我们非常欢迎贡献!安装开发版本、构建示例文档以及开发主题的CSS/JS
等,在文档的贡献部分有更详细的解释。
项目详情
下载文件
下载您平台上的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。
源分布
pydata_sphinx_theme-0.15.4.tar.gz (2.4 MB 查看哈希值)