sphinx-me

スフィンクス - 私はあなたのプロジェクトのためにSphinxのドキュメントシェルを作成し、マニュアルの索引などのREADMEファイルが含まれますPythonのツールです＆NBSP;。それは、あなたのプロジェクト名、作成者やバージョンなど、必要なメタデータを抽出処理しますあなたのスフィンクスのドキュメントで使用するためのプロジェクト。
あなたのスフィンクスのドキュメントを作成するためにスフィンクス-MEを使用したら、次に読む写真ザドキュメントのサイトにプロジェクトを追加して、魅力的なスフィンクスのドキュメントをテーマにホストされているプロジェクトのREADMEを持つことができます。
注：READMEファイルには、reStructuredTextの互換性のある形式にする必要があります。
インストール
スフィンクス、私をインストールする最も簡単な方法は、以下の各コマンドを実行して、ピップまたはsetuptoolsのを使用して、PyPIのから直接です。
インストールPIP -Uスフィンクス、私を
または：
easy_installを-Uのスフィンクス、私
そうでなければ、スフィンクス、私をダウンロードすることができますし、ソースから直接インストールします。
Pythonはsetup.py installを
ランニング
スフィンクスは、私はしばらくの間、プロジェクトのルートディレクトリにコマンドラインから実行することができ、システム全体のスクリプトとしてインストールされます。
スフィンクス、私
プロジェクトのディレクトリ内で実行すると、二つのファイル、Sphinxのconf.pyモジュール、およびプロジェクトのREADMEが含まれますindex.rstファイルにdocsディレクトリが作成されます。
conf.pyモジュールは、Sphinxのドキュメントのために最低限必要な設定を設定スフィンクス、私からのセットアップ機能を呼び出します。
- プロジェクト - プロジェクトのディレクトリ名が使用されています。
- バージョン - あなたのsetup.pyスクリプト、またはあなたのパッケージの__VERSION__属性のバージョン引数から取得しました。
- 著作権 - あなたのsetup.pyスクリプトの作者の引数から取得したり、あなたのパッケージの__author__属性

この要件：

このPythonの。