Xây dựng tài liệu

Tài liệu này giải thích cách xây dựng tài liệu Sphinx cho ứng dụng Parrot. Chúng ta sẽ bao gồ

Ghi chú

Parrot đang ở trong giai đoạn phát triển sơ khai, không sẵn sàng cho người dùng cuối.

Hướng dẫn cài đặt

Đặt hàng thực hiện sử dụng câu lệnh này: Đầu tiên, sao chép kho lưu trữ sử dụng lệnh này:
```
git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
```
Chuyển đến thư mục của kho lưu trữ: Sau khi sao chép, di chuyển đến thư mục gốc dự án bằng cách chạy:
```
cd parrot-wtf
```

Cài đặt python3-venv (apt): Điều này là cần thiết để tạo môi trường ảo. Chạy lệnh này:

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

Thiết lập môi trường ảo (venv): Điều hướng đến thư mục gốc dự án của bạn và chạy:
```
python3 -m venv venv
```
Kích hoạt môi trường ảo: Trước khi cài đặt bất kỳ gói nào, hãy kích hoạt môi trường ảo bằng cách chạy:
```
source venv/bin/activate
```
Sử dụng requirements.txt: Tập tin này chứa danh sách phụ thuộc của dự án. Để cài đặt chúng bằng pip, hãy chạy:
```
pip install -r requirements.txt
```

Cài đặt các mô-đun con: Cài đặt các mô-đun con khác từ kho Parrot để bao gồm tài liệu của chúng.

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

Xây dựng tài liệu

Xóa lần xây dựng hiện tại: Nếu bạn đã xây dựng tài liệu trước đó, hãy bắt đầu bằng cách loại bỏ các tập tin xây dựng
```
make clean
```
Xây dựng phiên bản HTML của tài liệu: Ứng dụng Parrot sử dụng Sphinx để tạo ra tài liệu hướng dẫn. Để tạo ra phiên bản HTML,
```
make html
```
Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:
```
make help
```

Gửi đến Máy chủ Web

Sau khi tạo tài liệu, bạn sẽ tìm thấy các tập tin HTML trong thư mục build/html. Đây là các tập tin cần phải được tải lên vào máy chủ

Chỉnh sửa .env để đặt URL máy chủ được sử dụng bởi rsync, ví dụ:

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

Chạy lệnh sau để rsync tới máy chủ:

./scripts/rsync-parrot-wtf

Chúng tôi sẽ tải lên tất cả các tập tin HTML trong build/html

Ghi chú

Tài liệu về đại tu và sử dụng máy móc chuyên gia ngôn ngữ khác cho người Việt.