# 如何在本地构建文档

要为 Dagor Engine 生成本地文档，请执行以下步骤：

1. **克隆存储库**

   克隆 [Dagor Engine 存储库](https://github.com/GaijinEntertainment/DagorEngine).

2. **安装 Python**

   下载并安装[Python](https://www.python.org/downloads/).

3. **安装 Sphinx及其依赖**

   使用提供的配置文件安装[Sphinx](https://www.sphinx-doc.org/en/master/)和所需的组件：

   ```text
   pip install -r requirements.txt
   ```

   ```{note}
   在 Windows 上，必须使用管理员权限安装 Sphinx 及其依赖项。
   ```

4. **安装 Doxygen**

   下载并安装 [Doxygen](https://www.doxygen.nl/).

   ```{note}
   在 Windows 上，将 Doxygen 添加到环境 PATH 中：
   `$env:PATH=$env:PATH+';<doxygen_installation_dir>\bin\'`,
   替换 `<doxygen_installation_dir>` 为Doxygen的安装目录 (例如, `c:\Program Files\doxygen`).
   ```

5. **构建文档**

   在`DagorEngine/_docs`目录中，执行以下步骤：

   - **运行构建脚本**

     执行脚本以解析源文件：

     ```text
     python3 build_all_docs.py
     ```

     该脚本将处理来自`DagorEngine/prog`的文档并将其输出到`_docs/source/`。

   - **运行Sphinx构建命令**

     使用 Sphinx 构建文档：

     ```text
     sphinx-build -c . -b html source _build
     ```

     默认情况下，Sphinx 将以 HTML 格式生成文档，将输出放在`_docs/_build`中。

6. **查看文档**

   打开位于`_docs/_build`中的`index.html`文件以查看生成的文档。