构建文档

此文档说明如何为Parrot应用程序构建Sphinx文档。我们将讨论设置虚拟环境（venv

备注

鹦鹉仍在初期开发阶段，尚未准备好面向最终用户。

Setup Instructions

1. 克隆仓库：首先，使用此命令克隆仓库：

   git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
   

2. 进入存储库的目录：克隆后，通过运行以下命令导航到项目的根目录：

   cd parrot-wtf
   

3. 安装python3-venv (apt)： 这是创建虚拟环境所必需的。运行此命令：

   sudo apt update
   sudo apt install docutils gettext python3-pip python3-venv
   # To build PDFs with LaTeX
   sudo apt install texlive-full xindy
   

4. 在项目的根目录下，运行以启动虚拟环境（venv）：

   python3 -m venv venv
   

5. **激活虚拟环境：**在安装任何包之前，通过运行以下命令激活虚拟环境：

   source venv/bin/activate
   

6. 使用requirements.txt： 此文件包含项目依赖项列表。要使用pip安装它们，请运行：

   pip install -r requirements.txt
   

7. 安装子模块： 安装其他 Parrot 库子模块，以包含它们的文档。

   pip install -r datasets/requirements.txt
   pip install -r extension/requirements.txt
   pip install -r ide/requirements.txt
   pip install -r models/requirements.txt
   
   pip install -e datasets
   

构建文档

1. 清除现有构建： 如果您之前已构建文档，首先可以使用此命令清除旧的构建文件：

   make clean
   

2. 构建文档的HTML版本： Parrot应用程序使用Sphinx生成其文档。要创建HTML版本，请运行：

   make html
   

3. Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:

   make help
   

推送到网页服务器

在构建文档后，您将在 build/html 目录中找到HTML文件。这些是需要上传到您的网络服务器上的文件。

编辑``.env``文件以设置“rsync”所使用的服务器URL，例如：

URL="parrot.wtf:/var/www/html/parrot-wtf/"

运行以下命令到“服务器”进行“rsync”：

./scripts/rsync-parrot-wtf

这将推送所有的HTML文件到您的主服务器。 <build/html>

备注

鹦鹉文档是用英语编写的，并使用人工智能机器翻译来翻译其他语言。