ドキュメントの構築

このドキュメントでは、Parrotアプリケーション用のSphinxドキュメンテーションを構築する方法について�

注釈

パラオトはまだエンドユーザーに対応していない開発中です。

セットアップ手順

リポジトリのクローン：まず、このコマンドを使用してリポジトリをクローンしてください：
```
git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
```
リポジトリへディレクトリを変更: クローン後、実行によってプロジェクトのルートディレクトリに移動:
```
cd parrot-wtf
```

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

仮想環境(venv)を設定します： プロジェクトのルートディレクトリに移動して、次のように実行します。
```
python3 -m venv venv
```
仮想環境をアクティベートしてください: パッケージのインストール前に、次のコマンドで仮想環境をアクティベートしてください:
```
source venv/bin/activate
```
requirements.txt ファイルを使用します： このファイルには、プロジェクトの依存関係のリストが含まれています。pip を使用してインストールするには、次のように実行します:
```
pip install -r requirements.txt
```

サブモジュールのインストール： 他の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

ドキュメントを作成中

"既存のビルドをクリーンアップする: もしドキュメントを以前にビルドしたことがあるなら、まずこのコマンドで古いビルドファイルをクリーンアップしてください:
```
make clean
```
"ドキュメントのHTMLバージョンを作成する: ParrotアプリケーションはSphinxを使用してドキュメントを生成します。HTMLバージョンを作成するには、次のように実行します:"
```
make html
```
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」からメインサーバーにプッシュします。

注釈

パーロットのドキュメントは英語で記述されており、他の言語への翻訳にはAI機械翻訳を使用しています。