tl.pkgはスフィンクスのドキュメントを持つ名前空間Pythonパッケージ用のテンプレートです。
このパッケージには、スフィンクスのドキュメントや開発ビルドアウトとPythonパッケージの基本的なファイルとディレクトリのレイアウトを生成します。それは、2つの部分から構成されます。
- ネームスペースの1レベルに住んでいるPythonパッケージ用の定型を作成paste.scriptテンプレート、および
- 必要なパッケージの依存関係といくつかのテーマに沿って、スフィンクスを構成するために使用されPythonモジュール。
パッケージは、Python 2.6と2.7で動作します。
の使用法の
ペースターテンプレートを利用できるようにするには、ペースターはそれを見つけることができtl.pkgをインストールしてください。その後、ペースターを実行します。
＆NBSP;ペースター--template TL-PKGの作成<空間> <プロジェクト>。
これはzc.buildout構成、スフィンクスのパッケージのドキュメントのスケルトン、および初期化のMercurialリポジトリとの完全な卵の配布のための決まり文句を、生成されます。それはビン/テストでのテストランナーとビン/ docにあるドキュメントビルダーがインストールされますので、ビルドアウト構成は、開発対象としています。
いくつかの変数は、それらの間の1行の説明とパッケージのためのいくつかのキーワード、の入力を求められます。
のパーソナライゼーションの
ペースターはをお願いさらに3つの変数は、それが生成されるパッケージの骨格をパーソナライズするために使用されます。これらの変数は、それが存在する場合は、$ HOME / .tl-pkg.cfgという名前のファイルから読み込まれ、デフォルト値を有することができる。ファイルには、PythonのとConfigParserが理解されるようなINIファイルの構文に従って、次の変数のいずれかを定義します（これまでの任意の名前を持つ）1セクションが含まれている必要があります：
著者：あなたのフルネーム。これは、パッケージのメタデータと文書にだけでなく、生成されたPythonのファイルの著作権表示に表示されます。
著者 - 電子メール：あなたのメールアドレス。これは、両方のパッケージのメタデータとドキュメントに表示されます。
Bitbucketの-：お名前（名）：Bitbucketのユーザー名。これは、プロジェクトに所属するさまざまなURLを構築するために使用されます。現在では、仮定は、プロジェクトが
のパッケージ内容の
これは時に編集するファイルをアドバイスとともに、生成されたファイルやディレクトリの目的を説明することである。多くのファイルは、一切編集する必要はありません。
Python配布
setup.py：パッケージ定義とメタデータ。パッケージのバージョン番号、依存関係、エントリポイントが変更されるたびに、少なくともこのファイルを更新します。
<空間>：パッケージのソースコードツリー。同じ名前空間内の他のパッケージをインポートすることができないないように、名前空間のパッケージの__init__.pyファイルを変更しないでください。
Mercurialのリポジトリ
の.hg：パッケージが作成されたときのMercurialリポジトリが既に初期化される。生成されたファイルは、まだコミットされていない。
の.hg / hgrcファイル：リポジトリの構成があれば、いくつかのMercurialのホスティングパッケージの将来のURLを指しています。また、あなたのHGのユーザー名を設定します。
これにチェックを入れる：ファイルとディレクトリはMercurialのでは無視される。これはビルドアウトは、ドキュメントのビルドまたはパッケージのリリースによって生成されることが期待ローカル設定やものが含まれています。それは（そのような* .pycファイルなど）のPythonによって生成されたファイルが含まれていない、（* .egg-info）を配布し、またはこのプロジェクトに固有のものではありません、あなたのエディタのような他のより一般的なツール、。このようなパターンは、あなたのデフォルトMercurialの無視リストにする必要があります。
開発ビルドアウト
bootstrap.py：ビン/ビルドアウトスクリプトを作成します。ビルドアウトが使用する同じPythonインタプリタでこれを実行します。今までにこのファイルを編集する必要はありません。
buildout.cfg：テストランナーとパッケージのドキュメントビルダを作成する作業ビルドアウト設定。パッケージ自体は開発卵として含まれているとビルドアウトは、他のパッケージの唯一のピン止めのバージョンを使用するように設定されている。パッケージの政府開発ビルドアウトを設定しますがlocal.cfgでローカルなカスタマイズを置くためにこれを編集します。このファイルのバージョンセクションでは、この同じファイルのビルドアウト部で卵を開発宣言されているパッケージのpinningsだけ元に戻す必要がありますが、バージョンpinningsはバージョン/ versions.cfgに行く。
local.cfg：他の開発者への無関心のあるビルドアウト構成のローカルなカスタマイズ。これはMercurialのでは無視されています。その後上からこのファイルを変更した場合、実行ビン/ビルドアウト-c local.cfg。これはbuildout.cfgで、バージョン管理下に非ローカルの設定を残したまま、最初は面倒な聞こえるかもしれないがこのような連続-統合サーバー上のパッケージをテストとしてのユースケースのために重要である。
バージョン/ versions.cfg：
＆NBSP;バージョンはZopeのツールキットの一部ではないビルドアウトで使用されるすべてのパッケージのピン止め。ドキュメントを作成するために必要とされるtl.pkgのバージョンは、パッケージファイルを作成したのと同じバージョンに固定されている。後でtl.pkgアップグレードするときは、このバージョンのピン止めは、バージョン間のパッケージテンプレートで変更されたすべてのファイルと一緒に更新する必要がある。あなたのパッケージまたはあなたの増築に必要なすべての卵のバージョンのピンにこのファイルを編集します。
バージョン/ ztk-バージョン-X.Y.Z.cfg：
＆NBSP; Zopeのツールキットの固定リリースは、私たちのバージョンpinningsに含まれています。こののローカルコピーを維持することは、ネットワーク·アクセスなしでビルドアウトを構築することができます。このファイルを編集しないでください。
一般的なパッケージのドキュメント
ドキュメントの標準部品が含まれているため、その場所に、それらの特定の名前で期待されている、とスフィンクスのアクセス可能無関係であることが必要です、パッケージの最上位ディレクトリに発見されるテキストファイルが多数あります。これらのファイルは、逐語的に含まれている著作権表示およびライセンステキストを除いて、完全なドキュメントを構築するとき、彼らはスフィンクスによって処理されているように有効な再構築テキストにする必要があります。
のREADME.txt：そのPyPIのページのとドキュメントのインデックスページの一部となるパッケージの目的、内容と使用方法の概要を説明。これは常にパッケージの内容を最新に維持されるべきである。
CHANGES.txt：パッケージの利用者に関連するパッケージへの変更で更新する必要がある変更ログ。ファイルの形式は、zest.releaserとそれの現在のバージョン（公共のMercurialリポジトリ内すなわち「チップ」バージョン）によって理解されているPyPIのページと構築されたパッケージのドキュメントから指されます。
ABOUT.TXT：そのような後者の電子メールアドレスなどのパッケージとその作者に関するいくつかのポインタ、およびパッケージのドキュメントのURLは、PyPIのページ、課題追跡とソースコードだけでなく、現在のログ。これは、ドキュメントはPyPIの時と
COPYRIGHT.txt：著作権の年とZopeの公衆ライセンス、デフォルトでは、バージョン2.1で使用されたライセンス、約いくつかのアドバイスなど、著作権者：パッケージの著作権情報。少なくとも年に更新するために、これを編集します。
LICENSE.txtを：使用ライセンスの公式テキストのコピー。これは別のライセンスのためにそれを交換する以外は編集しないでください。
完全なドキュメントは、スフィンクスを使用して構築された
DOC：スフィンクス - 生成されたドキュメントにのみ関連しすべて。私たちは、スフィンクス入力ファイルのサフィックスは.txtを使用しています。規則の数はdocディレクトリの内容のために存在するが、悪いものは何もあなたが自由にそれを変更した場合、パッケージの残りの部分に起こりません。ちょうどそれが有効なスフィンクス入力残ることを確認してください。
DOC / conf.py：スフィンクスの設定。基本的にはすべての設定値のは、規則に従うため、tl.pkgから輸入されているので、あなたはそのままtl.pkg.sphinxconfのインポートと呼び出しを維持する必要があります。あなたはメタデータまたはちょうどこのパッケージのドキュメントの外観について何かを変更したい場合は、このファイルを編集する必要があります。スフィンクス - 生成されるドキュメントの規則への更新はtl.pkgをアップグレードすることによって獲得されます。
DOC / index.txtの：ドキュメントのフロントページ。これは、トップレベルのREADME.txtファイルと完全なドキュメントのセクションを指しているの目次からパッケージの概要が含まれています。これらは、生成されたAPIドキュメント、パッケージと変更ログに関するいくつかのメタ情報が含まれています。あなたはトップレベルのセクションを追加したい場合は、このファイルを編集します。
DOC / narrative.txt：
＆NBSP;物語のパッケージのドキュメントのルート文書。これは、あなたのソースツリー内のPythonモジュール間で存在するすべてのDOC-テストファイルを収集することを意図している。あなたはそれらの文書名は、パターンのもの、toctreeディレクティブディレクティブの下にファイルを一覧表示する必要がある<空間> <パッケージ> - 。<ファイル名>（.txtのサフィックスなし）。コメントアウトされたサンプルファイルのリストが含まれています。
DOC / api.txt：生成されたAPIドキュメントのルート文書。 APIは、半自動的にあなたが自動サマリー指令の下で、すべてのモジュールがそれ以降自動的に行われた、文書化する、このファイルに一覧表示する必要があるという点で、文書化されています。コメントアウトされた例のモジュールのリストが含まれています。
DOC / overview.txt：
＆NBSP;最上位ファイルのREADME.txtを含むようにスタブ。このファイルを編集する必要はありません。
DOC / ABOUT.TXT：トップレベルのファイルABOUT.TXT、COPYRIGHT.txt、およびLICENSE.txtをを組み合わせたパッケージに関するメタ情報、。あなたはこのファイルを編集する必要はありません。
DOC / changes.txt：
＆NBSP;最上位ファイルCHANGES.txtを含むようにスタブ。このファイルを編集する必要はありません。
DOC / requirements.pip：
＆NBSP;ドキュメントを構築するために必要な（スフィンクス自体以外）のPythonの卵のリスト。これは、
の完全なドキュメントの作成の
生成されたビルドアウトの設定は、ドキュメントを構築するためにスフィンクスを呼び出して、ビン/ docに、スクリプトをインストールします。このスクリプトを実行するには、現在の作業ディレクトリは、パッケージのルートでなければなりません。スクリプトは、（パッケージの最上位ディレクトリからの相対）ビルド/ DOC /に内蔵されたドキュメントを配置します。ビン/ DOCに渡されたオプションは、下にあるスフィンクス-buildコマンドに渡さが、位置引数は動作しませんのでご注意されます。
のスフィンクスの設定値の
あなたがコアスフィンクス変数に加えて、これらを設定したい場合がありますので、デフォルトでは、スフィンクスの拡張機能の数は、有効になっている：
- 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は、真の値に設定した場合のマニュアルとスフィンクス実行を構築する際には、
最後に、tl.pkg.sphinxconfモジュールは、ドキュメントのようなシステム上に構築される場合は、モックモジュールを登録するために呼び出すことが関数を定義する
tl.pkg.sphinxconf.register_mock_modules（ 'カイロ'、 'GObjectの'、 'GTK'）
の要件の
- のPython
コメントが見つかりません