设置手动开发环境#

如果您不想使用像 tox 这样的自动化工具，或者希望对要安装的软件包的特定版本有更多控制，您可以手动设置本地开发环境。

为此，请按照本页上的说明进行操作。

创建新的开发环境#

这是可选的，但最好从新的开发环境开始，以便隔离您为此仓库使用的软件包。

为此，请使用 conda、mamba 或 virtualenv 等工具。

先决条件#

在开始之前，请确保已安装以下内容：

  • Python >= 3.9

  • Pandoc：使用 nbsphinx 来支持文档中的笔记本（.ipynb）文件，这需要在系统级别（或在 Conda 环境中）安装 Pandoc。

在本地克隆仓库#

首先从 pydata 组织或您创建的分支克隆此仓库：

$ git clone https://github.com/pydata/pydata-sphinx-theme
$ cd pydata-sphinx-theme

在本地安装此主题#

接下来，在本地安装此主题，以便我们拥有构建文档和测试套件所需的依赖项：

$ pip install -e ".[dev]"

请注意，sphinx-theme-builder 将自动安装本地 nodejs 副本以构建主题资源。这将放置在 .nodeenv 文件夹中。

构建文档#

要手动构建文档，请运行以下命令：

$ sphinx-build docs docs/_build/html

编译 Web 资源（JS/CSS）#

要为主题编译 JavaScript 和 CSS 资源，请运行以下命令：

$ stb compile

这将编译 src/pydata_sphinx_theme/assets 文件夹中的所有内容，并将它们放置在我们主题文件夹结构中的适当位置。

启动实时服务器以构建并提供您的文档#

要手动打开服务器以监视文档的更改、构建它们并在本地浏览器中显示它们，请运行以下命令：

$ stb serve docs --open-browser

手动运行测试#

要手动运行此主题的测试，请首先在本地设置您的环境，然后运行：

$ pytest