.
Okydoky는 스핑크스, 배포 및 GitHub의 (setuptools에 있던) & NBSP 사용하여 자동 문서 작성기이다 그것은 지속적으로 다음과 같은 가정으로, 문서화를 구축하기 위해 폐쇄 파이썬 프로젝트를 만든다 :
1. 문서는 스핑크스를 사용하여 수행됩니다.
2. 프로젝트는 (PIP이나 어떤 다른되지 않음) setuptools에 통해 패키지됩니다.
3. 소스 코드는 GitHub의에서 관리됩니다.
곧 말하는, 단순히 개인적인 용도로 ReadTheDocs.org입니다.
그것이 작동하는 방법
이 지침은 다음과 같이 작동합니다
새로운 커밋을 누를 때 1. GitHub의 후크를 포스트받을 Okydoky 트리거합니다.
2. Okydoky 다운로드 GitHub의에서 밀어 커밋의 아카이브를 타볼.
3. 타르볼 아카이브는 임시 디렉토리로 추출됩니다.
4. 스핑크스는 문서를 작성합니다.
사용자가 웹 브라우저를 사용하여 문서를 요청할 때 5. Okydoky는 GitHub의 OAuth를 사용하여 인증을하도록 사용자에게 요청한다.
그들이 권한이있는 경우 6. Okydoky는 내장 문서를 제공합니다.
사용 방법
그것은 일반 파이썬 패키지입니다. 당신은 easy_install을 사용하여 설치할 수 있습니다 :
& NBSP; easy_install을 Okydoky
이 패키지는 okydoky라는 명령 줄 스크립트를 제공합니다. 이 웹 응용 프로그램도 자체에 대한 작은 웹 서버입니다. 이 설정 파일을합니다.
구성 파일은 GitHub의 응용 프로그램 키와 비밀 키 같은 몇 가지 필요한 값을 포함해야합니다.
당신은 Okydoky를 사용하는 GitHub의 응용 프로그램을 만들어야합니다. 그 콜백 URL은 매우 중요합니다. 그것을 채우기 :
에 http : // <호스트> / 정식 / 마무리
및 대체 <호스트>는 사용합니다 어떤 도메인 이름. 그리고, 당신의 GitHub의 저장소로 포스트받을 후크를 추가 :
에 http : // <호스트> /
당신은 설정 파일을 만들 경우, okydoky 스크립트를 사용하여 Okydoky 서버를 실행 :
& NBSP; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
마지막으로, 설치를 완료하기 위해 초기 AUTH를 확인해야합니다. 열기에 http : // <호스트> / 웹 브라우저에서 거기에서 GitHub의 로그인.
구성
설정 파일은 일반 파이썬 스크립트입니다. 이 플라스크의 설정 시스템을 사용합니다. 설정 파일에 대해 플라스크의 문서를 참조하십시오.
REPOSITORY
& NBSP; 사용자와 저장소 이름 예를 들어, 'crosspop / okydoky'.
CLIENT_ID
& NBSP; GitHub의 응용 프로그램의 클라이언트 키.
CLIENT_SECRET
& NBSP; GitHub의 응용 프로그램의 비밀 키.
SAVE_DIRECTORY
& NBSP; 디렉토리의 경로는 데이터를 저장합니다. 이 디렉토리는 일부 구성된 데이터, 타르볼, 내장 문서화를 저장합니다.
SECRET_KEY
& NBSP; 비밀 키는 세션에 서명합니다. 또한 세션에 대한 플라스크의 문서를 참조하십시오.
오픈 소스
Okydoky은 Crosspop에 대한 홍콩 Minhee에 의해 작성되었습니다. 이것은 MIT 허가서와, 그리고 소스 코드 GitHub의 저장소에서 찾을 수있다. 체크 아웃 :
& NBSP; 자식 복제 자식 : //github.com/crosspop/okydoky.git
이 릴리스의 새로운 기능입니다 무엇 :
이 GitHub의 OAuth를위한 상태를 강요했다. 그 사항을 따르십시오.
이 버전 0.9.4의 새로운 기능 :
이 명령을 개발 setup.py에 대한 --upgrade 옵션을 사용합니다. 이 종속성 버전 충돌을 방지 할 수 있습니다.
빌드 로그는 build.txt 파일에 남아 있습니다.
이 버전 0.9.3의 새로운 기능 :
이제 인덱스 페이지는 심판의 목록을 보여줍니다.
지금 Okydoky 세트는 빌드 과정 = 1 환경 변수를 OKYDOKY. [# 5]
/ 머리 특수 심판 URL을 추가합니다.
머리가 최신 커밋으로 설정되지 않은 버그가 수정되었습니다.
이 버전 0.9.2의 새로운 기능 :
는 보안 버그 수정 : 이제 사용자가 저장소에 대한 권한이 있어야합니다. [# 4]
이 요구 사항 :
이 파이썬
댓글을 찾을 수 없습니다