개발자 가이드에 기여하기

개발자 가이드(현재 읽고 있는 문서)는 몇 가지 사소한 차이점을 제외하면 기본 Python 문서와 동일한 절차를 사용합니다. 소스는 separate repository에 있으며 버그 보고서는 devguide GitHub tracker에 제출해야 합니다.

개발자 가이드의 변경 사항은 풀 리퀘스트가 병합되면 게시됩니다.

Python 문서의 변경 사항은 정기적으로, 일반적으로 변경 사항이 커밋된 후 48시간 이내에 게시됩니다. 문서는 또한 각 릴리스마다 게시되며, 재배포자도 이를 사용할 수 있습니다.

개발자 가이드 작업 흐름

관련 풀 리퀘스트를 제출하려면 devguide repo를 GitHub 계정으로 포크하고 다음을 사용하여 복제할 수 있습니다.:

$ git clone https://github.com/<your_username>/devguide

PR이 승인되려면 기여자 계약에도 서명해야 합니다.

devguide를 빌드하려면 몇 가지 추가 의존성이 필요하며(그중 가장 중요한 의존성은 Sphinx입니다), Python 프로젝트에서 의존성을 설치하는 표준 방법은 가상 환경을 만든 다음 requirements.txt 파일에서 의존성을 설치하는 것입니다. 편의를 위해 이 모든 과정은 자동화되어 있습니다.

체크아웃 디렉터리에서 개발자 가이드를 빌드하려면 다음과 같이 하십시오.

Unix/macOS

make html

Windows

.\make html

생성된 파일은 _build/html에서 찾을 수 있습니다.

팁

• 웹 브라우저에서 문서를 열려면 html을 htmlview로 바꾸십시오 빌드가 완료된 후에 수행하십시오.

• 문서를 다시 빌드하고, 로컬 서버를 시작하며, reST 파일을 변경할 때 브라우저에서 페이지를 자동으로 다시 로드하려면 html을 htmllive로 바꾸십시오(Unix 전용).

관련 풀 리퀘스트를 제출하면 make check가 자동으로 실행된다는 점에 유의하십시오. 오류 없이 실행되는지 확인하려면 make check 및 make linkcheck를 실행하는 것이 좋습니다.