문서 작성

이 문서는 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
```
문서 번역: 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

이것은 “build/html”에서 모든 HTML 파일을 메인 서버로 푸시합니다.

참고

파랑 오리 문서는 영어로 작성되고, AI 기계 번역을 사용하여 다른 언어로 번역합니다.