問題タブ [autodoc]

現在、モジュール全体を .xml で文書化していますautodoc。ただし、長いリストまたは辞書を含むモジュール レベルでいくつかの変数を定義します。これらは値とともにドキュメントに含まれており、値はフォーマットされていないため、10 行の混乱のように見えます。私が望むのは、これらの変数のドキュメント文字列を含めることですが、値を省略するか、少なくとも適切にフォーマットすることです。

automodule変数をディレクティブから除外して、次のように追加しようとしました:

これにより、変数名のみが含まれ、docstring と値の両方がlongstuffドキュメントに存在しませんでした。

docstring を保持し、同時に値を削除する (または適切にフォーマットする) にはどうすればよいですか?

sphinxのドキュメントによると、.. autoattributeディレクティブはインスタンス属性をドキュメント化できる必要があります。しかし、私がそうするなら::

次に、ビルド時にAttributeErrorが発生します。

インスタンス化ElementTreeして属性にアクセスしようとしても、_root正常に機能します::

私は何が間違っているのですか？

（私は実際に自分のクラスの1つでこの問題を抱えていますが、標準ライブラリにあるため、例としてElementTreeクラスを使用しています）

Python でメタクラスを使用するコードがいくつかあります。しかし、sphinx autodoc を実行すると、次のエラーが発生します。

WARNING: py:class reference target not found: type

エラーは、自動生成された .rst ファイルの行で発生しています。

\__metaclass__また、blockList は、メタクラスに設定されている API.list.list を拡張します。

私が言えることから、スフィンクスは組み込み型クラスが存在するとは考えていません。組み込み型をインポートして、スフィンクスにその存在を認識させようとしましたが、うまくいきませんでした。

API.list.list からメタクラスの割り当てを削除し、コードからメタクラスを削除すると、sphinx は問題なく動作します。

以下を使用して、Fortran ファイルから Python モジュールを作成しました。

file1.f90Fortran モジュールが含まれています: foo、bar、bar。モジュールには次のfoo関数が含まれています: f、g、h。

f2py は function の docstring を自動的に書き込みますf。

mymod.soはディレクトリROOTに含まれており、自分の に追加ROOTしましたPYTHONPATH。

f関数の docstring には次のようにアクセスできます。

fsphinx の autodoc 拡張機能を使用して、関数のドキュメントを書きたいと思います。

しかし、それは失敗します:

スフィンクスは次のようにインポートしようとしていると思いますが、うまくいきません:

を含むパッケージをインポートしようとしました__init__.py。

どうすればスフィンクスにmymod.foo.fdoctringを見つけさせることができますか?

sphinx autodocを使用して、複数行の docstring の最初の行を特別な方法でフォーマットする方法はありますか?

検討：

生成される html コード:

次のようなものにしたい：

コード例：

私は試した：

しかし、それは機能しません。

私のために生成する方法はありdoc_bますか？

次のようなモジュールがあります。

...そして、次の.rstようなファイルがあります。

ドキュメントをビルドすると、次のようなスニペットを含む html ファイルが得られます。

mymodule.foobar. foob​​ar = 'とてつもなく長く醜い正規表現がここにある'

追加のドキュメントはこちら

私のモジュール。myfunc ( val='とてつもなく長く醜い正規表現がここにある' )

何とか何とか何とか

このstackoverflowの投稿に基づいて、モジュールを次のように変更することで変更できると思いました：

...しかし、それはうまくいきませんでした。体の一部として、醜いものの下に必要な署名を追加しただけです。これを適切にオーバーライドする方法を誰かが知っていますか?

（私はSphinx v1.1.3を使用しています。）

Slime-replを使用すると、ミニバッファーにこのメッセージが表示され、emacsが1秒間ハングします。

プロセスフィルターのエラー：間違った型引数：sequencep、：not-available

Slime-autodoc-modeをオフにすると発生しなくなります

誰かがそれを見たことがありますか？

Django 1.4.1 プロジェクトのモジュール autodocs のビルドに問題があります。 make html設定のインポートで問題が発生しているため、ドキュメント文字列の読み取りに失敗しているようです。私が見たすべてのオンラインガイドは、使用を提案しています

しかし、これは 1.4 で非推奨になり、このsettings.configure()方法は適切ではないようです。1.4 で機能させる方法については、それほど多くの情報は見つかりませんでした。を設定してみDJANGO_SETTINGSましたが、うまくいきません。助言がありますか？

Sphinxでどの.rstファイルとディレクトリを使用するかをどのように定義できますか？

テスト/構築/ドキュメント化スクリプトに自動ドキュメントジェネレーターを含めたいです。 sphinx-quickstartが私のワークスペースで実行され、index.rst-fileが作成されました。Sphinxはドキュメントに再構築されたテキストファイルを使用するため、ワークスペース内を移動し、sphinx-autogenを使用して手動で作成しました。その結果、tasks.rstファイルが作成されました（以下を参照）。

'make html'を使用すると、いくつかの警告が表示されます。

警告：自動モジュールの署名が無効です（u'tasks / add_to_config'）

警告：autodocはモジュール'tasks.add_to_config'をインポート/検索できません。エラーが報告されました：「wl_build.tasksという名前のモジュールがありません」。スペルとsys.pathを確認してください。

警告：自動ドキュメント化のためにインポートするモジュールがわからないu'tasks / add_to_config'（ドキュメントに「module」または「currentmodule」ディレクティブを配置するか、明示的なモジュール名を指定してみてください）

..。

私のindex.rst

tasks.rst