tl.pkg 스핑크스 워드 프로세서와 네임 스페이스 파이썬 패키지에 대한 템플릿입니다.
이 패키지는 스핑크스 문서 및 개발 buildout와 파이썬 패키지의 기본 파일 및 디렉토리 레이아웃을 생성합니다. 그것은 두 부분으로 구성되어 있습니다 :
- paste.script 네임 스페이스의 한 수준에 살고 파이썬 패키지에 대한 상용구를 생성 템플릿, 및
- 필요한 패키지 종속성 일부 테마와 함께, 스핑크스를 구성하는 데 사용되는 파이썬 모듈.
이 패키지는 파이썬 2.6 및 2.7와 함께 작동합니다.
용법
paster이 정보를 찾을 수있는 위치에 tl.pkg를 설치, paster 템플릿을 사용할 수 있도록합니다. 그런 다음 paster을 실행합니다
합니다. & nbsp; paster가 --template TL-PKG <네임 스페이스를 만들기>
이 zc.buildout 구성, 스핑크스 패키지 문서의 골격 및 초기화 의욕 저장소에 완전한 계란 유통에 대한 상용구를 생성합니다. 그것은 빈 / 테스트에서의 TestRunner 및 빈 / 문서에서 문서 빌더를 설치합니다 있도록 buildout 구성은, 개발 목표로하고있다.
몇 가지 변수는 그 중의 한 줄 설명과 패키지의 일부 키워드를 입력하라는 메시지가 표시됩니다.
개인화
paster가를 묻는 3 개의 변수가 생성 패키지 골격을 개인화하는 데 사용됩니다. 이러한 변수는 존재하는 경우 파일 이름의 $ HOME / .tl - pkg.cfg에서 읽 디폴트 값을 가질 수있다. 이 파일은 파이썬의 ConfigParser 이해하고 (지금까지 임의의 이름으로) 한 부분을 포함하기 때문에 다음과 같은 변수 중 하나를 정의하는 INI 파일 구문을 수행해야합니다 :
저자 : 귀하의 전체 이름. 이 패키지 메타 데이터 및 문서뿐만 아니라 생성 된 파이썬 파일의 저작권 표시에 나타납니다.
작성자의 이메일 : 당신의 이메일 주소. 이 패키지 메타 데이터 및 문서에 모두 나타납니다.
의 bitbucket 이름 : 귀하의 bitbucket 사용자 이름. 이 프로젝트에 속하는 다양한 URL을 구성하는데 사용된다. 현재, 가정은 프로젝트
패키지 내용물
이 때, 편집 할 파일에 대한 조언과 함께, 생성 된 파일 및 디렉토리의 목적을 설명하는 것이다. 대부분의 파일은 모두 편집 할 필요가 없습니다.
파이썬 배포본
setup.py : 패키지 정의 및 메타 데이터. 패키지의 버전 번호, 의존성, 엔트리 포인트가 변경 적어도 때마다이 파일을 업데이트합니다.
머큐리얼 저장소
.hg : 패키지가 만들어지면 의욕 저장소가 이미 초기화됩니다. 생성 된 파일은 아직 커밋되지 않았다.
.hg / hgrc : 저장소 구성이있는 경우, 일부 의욕 호스팅에서 패키지의 미래 URL를 가리 킵니다. 그것은 또한 당신의 HG 사용자 이름을 설정합니다.
.hgignore : 파일과 디렉토리는 의욕에 의해 무시된다. 이 buildout은, 문서 빌드 또는 패키지 릴리스에 의해 생성 될 것으로 예상 로컬 구성과 재료를 포함한다. 그것은 (* .egg-정보) 배포 또는이 프로젝트에 특정하지 않은 편집기와 같은 다른 일반적인 도구 (예 : .pyc 파일 * 등) 파이썬에 의해 생성 된 파일을 포함하지 않습니다. 기본 의욕이 무시 목록에 이러한 패턴이 있어야합니다.
개발 buildout
bootstrap.py는 : 빈 / buildout 스크립트를 작성합니다. buildout가 사용할 필요가 같은 파이썬 인터프리터와이를 실행합니다. 필요가 이제까지이 파일을 편집 없습니다.
buildout.cfg : 테스트 실행 및 패키지의 문서 빌더를 생성하는 작업 buildout 구성. 패키지 자체가 개발 달걀로 포함되며 buildout는 다른 패키지 만 핀드 버전을 사용하도록 구성된다. 패키지의 공적 개발 buildout을 구성하지만 local.cfg 로컬 사용자 정의한 넣어이를 편집합니다. 버전 pinnings는 versions.cfg이 파일의 버전 섹션은 선언이 동일한 파일의 buildout 섹션으로 계란을 개발하고 있습니다 패키지 pinnings을 취소해야 / 동안 버전으로 이동합니다.
local.cfg : 다른 개발자들에게 더 관심있는 buildout 구성의 로컬 사용자 정의한. 이 의욕에 의해 무시되고있다. 다음부터이 파일을 변경하는 경우, 실행 빈 / buildout -c local.cfg. 이 buildout.cfg 및 버전 제어하에 비 - 로컬 구성을 유지 처음 번거로운 들릴 수 있지만 이러한 연속 통합 서버 패키지 테스트로서 사용 사례에 중요하다.
버전 / versions.cfg :
& NBSP; 버전 조프 툴킷의 일부가 아닌 buildout에서 사용하는 패키지를 달아. 문서를 구축하기위한 필요 tl.pkg의 버전은 패키지 파일을 만든 동일한 버전에 고정됩니다. 나중에 tl.pkg 업그레이드 할 때, 요구를 달아이 버전은 버전 사이의 패키지 템플릿에 변경 한 파일과 함께 업데이트합니다. 패키지 또는 buildout에 필요한 달걀의 버전을 고정하려면이 파일을 편집합니다.
버전 / ztk-버전-X.Y.Z.cfg :
& NBSP; 조프 툴킷의 고정 된 릴리스는, 우리의 버전 pinnings에 포함되어 있습니다. 이것의 로컬 복사본을 유지하는 것은 네트워크 액세스 권한이없는 buildout을 구축 할 수 있습니다. 이 파일을 편집하지 마십시오.
일반 패키지 문서
문서의 표준 조각을 포함하기 때문에 그 장소에 자신의 특정 이름으로 예상되며, 스핑크스의 접근 독립적 일 필요는 패키지의 최상위 디렉토리에 텍스트 파일은 여러 가지가있을 수 있습니다. 이 파일은 그대로 포함 된 저작권 표시 및 라이센스 텍스트를 제외하고, 전체 문서를 만들 때 그들이 스핑크스에 의해 처리되는 유효한 구조 조정 텍스트 할 필요가있다.
README.txt의 : 그 PyPI 페이지 및 문서의 인덱스 페이지의 일부가 될 패키지의 목적, 내용 및 사용에 대한 개요. 이는 최신 항상 패키지 내용물 보관한다.
CHANGES.txt : 패키지의 사용자와 관련된 패키지의 모든 변경 업데이트해야 변경 로그. 파일의 형식은 zest.releaser과 (공공 의욕 저장소에서 "끝"버전 예) 그것의 현재 버전 PyPI 페이지와 내장 패키지 문서에서 지적 될 것으로 이해된다.
ABOUT.TXT : 패키지 및 후자의 전자 메일 주소 등의 저자, 패키지의 문서의 URL을 PyPI 페이지, 이슈 트래커 및 소스 코드뿐만 아니라 현재 로그에 대한 몇 가지 포인터. 그것은 그 문서는 PyPI에와
COPYRIGHT.txt : 저작권 년 조프 공공 라이센스, 기본적으로 버전 2.1 사용 라이센스에 대한 몇 가지 조언을 포함 저작권자 : 패키지에 대한 저작권 정보를 표시합니다. 적어도 년 갱신하려면이를 편집합니다.
LICENSE.TXT : 사용 라이센스의 공식 텍스트의 복사본입니다. 이 다른 라이선스로 교환하는 경우는 예외로 편집하지 마십시오.
전체 문서, 스핑크스를 사용하여 구축
의사 : 스핑크스 - 생성 된 문서에만 관련이 다. 우리는 스핑크스 입력 파일에 대한 접미사이 .txt를 사용합니다. 규칙의 수는 doc 디렉토리의 내용을 위해 존재하지만, 나쁜 아무것도 당신이 자유롭게 수정할 경우 패키지의 나머지 부분에 일어나지 않습니다; 그냥 유효한 스핑크스 입력 상태로 있어야합니다.
문서 / conf.py : 스핑크스 구성. 기본적으로 모든 구성 값이 규칙을 따라야하기 때문에 tl.pkg에서 가져온, 그래서 당신은 tl.pkg.sphinxconf 그대로의 가져 오기 및 호출을 유지해야합니다. 메타 데이터하거나이 패키지에 대한 문서의 모양에 대해 뭔가를 변경하려는 경우이 파일을 편집해야합니다. 스핑크스 - 생성 된 문서에 대한 규칙에 대한 업데이트가 tl.pkg을 업그레이드하여 할당됩니다.
문서 / index.txt가 : 문서의 첫 페이지. 그것은 최상위 readme.txt 파일 및 전체 문서의 섹션을 가리키는 내용의 테이블에서 패키지 개요가 포함되어 있습니다. 다음은 생성 된 API 문서, 패키지 및 변경 로그에 대한 몇 가지 메타 정보를 포함한다. 당신은 예를 들어, 최상위 섹션을 추가하려면이 파일을 편집합니다.
문서 / narrative.txt :
& NBSP; 이야기 패키지 문서의 루트 문서. 이 소스 트리에서 파이썬 모듈 사이에있는 모든 문서 테스트 파일을 수집하기위한 것입니다. 당신은 자신의 문서 이름은 패턴되고, toctree 지시문에서 파일을 나열 할 필요가
문서 / 안의 api.txt : 생성 된 API 문서의 루트 문서. API는 반 자동으로 autosummary 지침에 의거하여, 모든 모듈이 다음부터 자동으로 수행하는 문서화하기 위해이 파일에 나열 할 필요가 있다는 점에서 설명되어 있습니다. 주석 처리 된 예 모듈 목록이 포함되어 있습니다.
문서 / overview.txt :
& NBSP; 스텁 최상위 Readme.txt 파일을 포함합니다. 필요가이 파일을 편집 없습니다.
ABOUT.TXT 문서 / : 패키지에 대한 메타 정보, 최상위 파일 ABOUT.TXT, COPYRIGHT.txt 및 LICENSE.TXT을 결합. 이 파일을 편집 할 필요가 없습니다.
문서 / changes.txt :
& NBSP; 스텁 최상위 파일 CHANGES.txt을 포함합니다. 필요가이 파일을 편집 없습니다.
문서 / requirements.pip :
& NBSP; 문서를 만드는 데 필요한 (스핑크스 자체보다 다른) 파이썬 달걀의 목록. 이것은
전체 문서를 구축
생성 된 buildout 구성은 문서를 구축하는 스핑크스를 호출 빈 / 문서에 스크립트를 설치합니다. 이 스크립트를 실행하려면, 현재 작업 디렉토리는 패키지의 루트를 지정할 필요가 있습니다. 스크립트는 (패키지의 최상위 디렉토리에 상대적으로) 빌드 / 문서 /에 내장 된 문서를 넣어 것입니다. 빈 / 문서 전달 옵션은 기본 스핑크스 빌드 명령에 전달하지만, 위치 인수가 작동하지 않습니다 유의한다.
스핑크스 구성 값
당신은 핵심 스핑크스 변수 외에이를 구성 할 수 있도록 기본적으로 스핑크스 확장의 수는, 사용할 수 있습니다 :
- sphinx.ext.autosummary
- sphinx.ext.viewcode
- sphinx.ext.inheritance_diagram
- sphinxcontrib.cheeseshop
- sphinxcontrib.issuetracker
당신은 단순히 당신의 conf.py.에서 각각의 변수를 설정하여 tl.pkg에서 기본값을 대체 할 수 있습니다 tl.pkg.sphinxconf.set_defaults의 호출은 마지막에 일어날 필요가있다 :
source_suffix = '.foo'
수입 tl.pkg.sphinxconf
tl.pkg.sphinxconf.set_defaults ()
반대로, sphinxconf 값을 계산하기 위해 conf.py에서 변수를 사용하려고합니다. 이러한 변수가 지정되면 set_defaults가 호출되기 전에, 그 또한 수행해야합니다. 현재, 다음과 같은 변수가 인식됩니다
_year_started : 프로젝트가 시작된 년 옵션 값. 이 매개 변수를 지정하고 현재 연도와 다른 경우 (문서의 건물시) 현재 연도에이 기본값이 있지만, 그것은 "2001년에서 2012년까지 저자"와 같은 저작권 표시를 구성하는 데 사용됩니다.
_flattr_url : 지정된 경우, 이것은 전체 문서의 메뉴 컬럼의 상단에 나타납니다이 프로젝트와 flattr 기부 버튼의 flattr 물건의 URL로 간주됩니다. PyPI 페이지에 flattr 버튼을 추가하려면, ABOUT.TXT에서 "프로젝트를 지원"항목의 주석을 해제하고 거기뿐만 아니라 URL를 입력합니다.
_issuetracker_offline :
& NBSP는, true 값으로 설정하면 문서와 스핑크스 실행을 구축 할 때 그것은
마지막으로, tl.pkg.sphinxconf 모듈은 문서와 같은 시스템에 구축 될 경우 모의 모듈을 등록하기 위해 호출 할 수 함수를 정의
tl.pkg.sphinxconf.register_mock_modules ( '카이로', 'G 객체', 'GTK')
이 요구 사항 :
이 파이썬
댓글을 찾을 수 없습니다