개발자 가이드 개선 돕기

개발자 가이드(지금 읽고 계신 문서)는 몇 가지 작은 차이점을 제외하면 주 Python 문서와 같은 절차를 따릅니다. 소스는 separate repository에 있으며, 버그 보고는 devguide GitHub tracker에 제출해야 합니다.

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

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

개발자 가이드 워크플로

풀 리퀘스트를 제출하려면 devguide repo를 자신의 GitHub 계정으로 포크한 후 다음 명령으로 클론할 수 있습니다::

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

PR이 받아들여지려면 기여자 동의서에도 서명해야 합니다.

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

체크아웃 디렉터리에서 devguide를 빌드하려면 다음과 같이 하십시오:

Unix/macOS

make html

Windows

.\make html

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

팁

• html을 htmlview로 바꾸면 웹 브라우저에서 문서를 열 수 있으며, 이는 빌드가 완료된 후에 이루어집니다.

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

풀 리퀘스트를 제출하면 make check가 자동으로 실행된다는 점에 유의하십시오. 오류 없이 실행되는지 확인하기 위해 make check와 make linkcheck를 직접 실행해 볼 수도 있습니다.