Okydoky

Okydokyはスフィンクス、配布し、（setuptoolsのだった）GitHubのを使用して自動ドキュメンテーションビルダーです＆NBSP;それは次のように仮定して、継続的にドキュメンテーションを構築するためにあなたの閉じたPythonプロジェクトを作成します。：
1.ドキュメントはスフィンクスを使用して行われます。
2.プロジェクトが（PIPも他のものではない）はsetuptoolsを通じてパッケージ化されています。
3.ソースコードはGitHubの下で管理されている。
まもなく言っても、それは単に私的使用のためのReadTheDocs.orgだ。
<強い>は、のしくみ
これは、次の手順で動作します：
新しいコミットがプッシュされている場合1.、GitHubのはOkydokyポスト受けるフックをトリガします。
2. OkydokyダウンロードはGitHubのからプッシュコミットのアーカイブをtarballに。
3.のtarballアーカイブが一時ディレクトリに抽出されます。
4.スフィンクスは、ドキュメントを作成します。
ユーザーが自分のWebブラウザを使用してドキュメントを要求すると5、OkydokyはGitHubのOAuthのを使用して認証するようにユーザーに要求します。
6.彼らが権限を持っている場合は、Okydokyは、組み込みのドキュメントを提供しています。
の使用方法の
これは、通常のPythonパッケージです。あなたはeasy_installを使用して、それをインストールすることができます。
＆NBSP; easy_installをOkydoky
このパッケージには、okydokyと呼ばれるコマンドラインスクリプトを提供しています。これは、Webアプリケーションと、それ自体のための小規模なWebサーバーです。これは、設定ファイルを取ります。
設定ファイルは、GitHubのアプリケーションキーと秘密鍵のようないくつかの必要な値が含まれている必要があります。
あなたはOkydokyを使用するには、GitHubのアプリケーションを作成する必要があります。そのコールバックURLは非常に重要です。でそれを入力します。
のhttp：// <ホスト> / AUTH /ファイナライズ
と置き換え、<ホスト>は、使用しますどのようなドメイン名を持つ。そして、あなたのGitHubのリポジトリにポスト受けるフックを追加します。
のhttp：// <ホスト> /
あなたが設定ファイルを作成する場合は、okydokyスクリプトを使用してOkydokyサーバーを実行します。
＆NBSP; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
最後に、インストールを完了するために初期認証を行う必要があります。オープンはhttp：// <ホスト> / Webブラウザで、そこからGitHubのを使ってログイン。
のコンフィグレーションの
設定ファイルは、通常のPythonスクリプトです。これは、フラスコのconfigシステムを使用しています。設定ファイルについてのフラスコのドキュメントをお読みください。
リポジトリ
＆NBSP;ユーザーとリポジトリ名例えば「crosspop / okydoky」。
CLIENT_ID
＆NBSP; GitHubのアプリケーションのクライアントキー。
CLIENT_SECRET
＆NBSP; GitHubのアプリケーションの秘密鍵。
SAVE_DIRECTORY
とをタップ、ディレクトリのパスは、データを格納する。このディレクトリには、いくつかの構成されたデータ、tarボール、および構築されたドキュメンテーションを保存します。
SECRET_KEY
＆NBSP;セッションに署名するための秘密鍵。また、セッションに関するフラスコのドキュメントを参照してください。
のオープンソースの
OkydokyはCrosspopのために香港Minheeによって書かれている。これは、MITライセンスの下で配布され、ソースコードはGitHubのリポジトリで見つけることができます。チェックアウト：
＆NBSP; gitのクローンgitの：//github.com/crosspop/okydoky.git

のこのリリースではの新機能：

• GitHubのは、OAuthのた​​めの状態を余儀なくされた。その従います。

のバージョン0.9.4でのの新機能：開発setup.pyのための

• を使用--upgradeオプションコマンド。これは、依存関係のバージョンの競合を防ぎます。
• ビルドのログがbuild.txtファイルに残されます。

今すぐインデックスページは、参考文献のリストを示しています。

のバージョン0.9.3でのの新機能である。

• 次にOkydokyはそのビルドプロセス中にOKYDOKY = 1環境変数を設定します。 [＃5]
• の追加/頭特別REFのURLます。
• ヘッドがコミット最新に設定されていないバグを修正します。

のバージョン0.9.2の新機能のは何ですか。

• セキュリティバグ修正：今、ユーザーが持っている必要がありますリポジトリの承認。 [＃4]

の要件の

• のPythonます。