問題タブ [python-sphinx]

Hudson を使用して、Sphinx を使用する Python プロジェクトのドキュメントを生成しています。これにより、フォルダー project/_build/html に HTML ドキュメントが生成されます。これをビルド アーティファクトとして使用するように設定しました。ジョブを実行した後、[Artifacts] リンクをクリックし、次にフォルダーをクリックし、次に index.html ファイルをクリックして、ドキュメントに移動できます。これは少し面倒なので、プロジェクト ページをカスタマイズして、index.html ファイルに直接アクセスできる [ドキュメントの表示] リンクを作成したいと考えています。ハドソンでそれを行う方法はありますか？

私はCで書かれたサブモジュールを含むPythonモジュールを書きました：モジュール自体が呼び出されfoo、C部分はfoo._barです。構造は次のようになります。

foo/__init__.pyそれを補強するためにインポート_barし、有用なものがfooモジュールに公開されます。_barこれはビルド時に正常に機能しますが、ビルドされるまで存在しないため、コンパイルされていない形式では明らかに機能しません。

Sphinxを使用してプロジェクトを文書化し、モジュールでautodoc拡張機能を使用したいと思いfooます。これは、ドキュメントを作成する前にプロジェクトを作成する必要があることを意味します。

distutilsを使用してビルドするため、ビルドされたモジュールは、さまざまな名前のdirになります。build/lib.linux-ARCH-PYVERSIONつまり、ディレクトリをSphinxにハードコーディングすることはできませんconf.py。

setup.pyでは、ビルドされたモジュールに対してSphinxビルダーを実行するようにdistutilsスクリプトを構成するにはどうすればよいですか？

完全を期すために、ここに次の呼び出しがありますsetup（「偽の」ものはサブクラス化するカスタムビルダーでbuildあり、build_ext）：

私はスフィンクスを使っている初心者です。かなり良さそうです。autodocを使用してほとんどすべてのプロジェクトを文書化しましたが、1つの動作を変更したいと思います。ドキュメントを読んで、私はこれを見ました：autodoc_member_order、そして'bysource'値に変更したい、ポイントは、この値をどこに置くべきかということです。

ありがとう、そして私は私の貧弱な英語をお詫びします。

更新：私はスフィンクス0.6.6を使用しています

reStructuredText で示されたリンク内のテキストをどのようにフォーマットしますか?

具体的には、最初から次の HTML を生成したいと考えています。

結果は次のようになります。

optparse.OptionParser ドキュメンテーション

ここで、「optparse.OptionParser」の部分は等幅フォントです。

私は試した

しかし、これは

このように見える

`` documentation <http://docs.python.org/library/optparse.html>\optparse.OptionParser_

Just curious if anyone knows how to customize the sphinx output when using the latexpdf target? I've seen lots of custom stuff for html output, but cant seem to find any example of custom pdf output.

Specifically, I'd be interested in customizing the title page, headers, footers, and possibly adding a few pages of front matter before the contents.

Has anyone seen any examples of this kind of customization, or do people pretty much just use the "stock" sphinx output when generating pdfs? Thanks!

Java で記述されたライブラリを使用して、いくつかの Jython プロジェクトに取り組んでいます。autodoc 拡張機能のおかげで、Sphinx を使用して優れたドキュメントを作成したいと考えています。ただし、html を作成しようとすると、autodoc が Java で記述されたライブラリを見つけられないため、エラーが発生します。

ここで、PoolManager は Java クラスです。

誰でもこの問題を解決するのを手伝ってもらえますか?

現在、スフィンクスで生成されたドキュメントを Django アプリに統合しています。アプリ テンプレートを拡張するためのドキュメントが必要です。Sphinx によって生成された HTML は次のようになります。

私のスフィンクスのテーマ テンプレートの外観は次のとおりです。

これを達成するためのより良い方法はありますか？

私はそれほど小さくないpythonパッケージを持っており、かなりの歴史があり、docstringsで文書化されています。その開発中に、buildbotを導入し、後でJenkins/Hudsonに導入しました。最近、ソースからドキュメントを収集し、Webでアクセス可能なドキュメントを最新の状態に保つために、スフィンクスのレシピを追加しました。buildbot.cfg

これまでのところ、とても良いです。変更をコミットするたびに、Jenkinsはパッケージを広範囲にチェックし、非常に完全な概要を生成し、ドキュメントサイトを更新します。

私が有効にしたスフィンクス拡張機能の1つ：カバレッジ、現在ドキュメント化されていないドキュメントカバレッジレポート用。

buildbotで生成された環境でsphinxを実行しましたが、sphinxで生成されたドキュメントサイトにカバレッジ統計を含めることができなかったようです。

ヒントはありますか？

sphinxのautdoc拡張機能を使用しようとしましたが、機能しません。「docs」フォルダをdjanoプロジェクトフォルダに保存しました。モジュールのドキュメントが生成されません。また、auto-todoがどのように機能するのかわかりません。

reST 経由でドキュメントを生成したいのですが、手動で reST ソースを書きたくないのですが、Python スクリプトにそれをさせてから、sphinx で他の形式 (HTML、PDF) を生成します。

バイナリ形式の電話帳があるとします。次に、Python スクリプトを使用してこれを解析し、すべての名前と番号を含むドキュメントを生成します。

次に、pdf と html を生成するために sphinx を呼び出します。

reSTを生成するためのAPIを提供するpythonモジュール（上記の例ではrestProducer）はありますか？または、いくつかの print ステートメントを介して reST マークアップをダンプする最良の方法はありますか?