手动设置开发环境#

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

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

创建新的开发环境#

这是可选的，但最好从一个新的开发环境开始，这样您就可以隔离用于此存储库的软件包。

为此，请使用像 conda、mamba 或 virtualenv 这样的工具。

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

首先从 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

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

$ stb compile

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

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

$ stb serve docs --open-browser

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

$ pytest