問題タブ [autodoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
2 に答える
484 参照

python-2.7 - モック化されたクラスを拡張するクラスを autodoc する

外部クラスを拡張するクラスに対して autodoc を実行しようとしています。

インポートが受け入れられるように、モックを使用しました。

そのために、このブログhttp://blog.rtwilson.com/how-to-make-your-sphinx-documentation-compile-with-readthedocs-when-youre-using-numpy-and-scipy/で説明されているものを使用しました

私が文書化しようとしている python ファイルは次のようになります: from de.xyz import class_that_is_extended

sphinx を実行すると、クラス名とソースへのリンクだけが表示されます。

「class extends_class (class_that_is_extended):」という行を「class extends_class (object):」に変更すると、sphinx/autodoc は docstring を含むドキュメントを生成します。

クラスをそのままにして、ドキュメントでdocstringを取得するにはどうすればよいですか?

0 投票する
0 に答える
312 参照

python-sphinx - autodoc を使用して Sphinx のサブクラスを一覧表示する

特定のクラスのすべてのサブクラスを一覧表示する autodoc ディレクティブはありますか?

次の Python コードがある場合:

次のような出力を生成する方法はありますか:

Sphinx、Autodoc、および再構成されたテキストを使用します。(:show-inheritance: と同様ですが、逆方向)。何かのようなもの:

0 投票する
1 に答える
51 参照

clojure - Autodoc で Leiningen がクラッシュする (sh が存在しない)

プロジェクトで Clojure autodoc を使用しようとしています。私の project.clj は次のようになります。

するとlein autodoc、このエラーが発生します

私はバイナリshを持っています

これを修正するにはどうすればよいですか?

0 投票する
1 に答える
284 参照

python - Sphinx: ハードウェア固有のライブラリが開発マシンで例外を発生させるため、特定のモジュールで autodoc が失敗する

私は Raspberry Pi と PiFace インターフェイス モジュールを含むプロジェクトに取り組んでいます。プロジェクトは Python で開発されており、Sphinx でいくつかのモジュールを自動ドキュメント化しようとすると問題が発生しました。ライブラリを使用していpifacedigitalioますが、このライブラリを開発マシンにインストールしましたが、Sphinx はモジュールのドキュメント化を拒否し、ハードウェアが存在しないために例外がスローされていると不平を言います。これは開発マシンであるため、ハードウェアは存在しません。ソフトウェアのテストには条件を使用するだけですif hwpresent then skipが、実際にはこれらの部分を Sphinx でドキュメント化したいと考えています。実行時に生成されるエラーmake htmlは次のとおりです。

Sphinx がコードを解釈するのを回避し、ソースを解析する方法はありますか? ダミーの戻り値を使用して手動で変更しようとしましpifacedigitalio/core.pyたが、Sphinx がフリーズします。

0 投票する
1 に答える
2025 参照

python - Sphinxのautodocでネストされたクラスを文書化する方法は?

Sphinx の autodoc プラグインを使用してネストされたクラスを文書化する方法はありますか?

の:

autoclassファイルでまたは同様のものを使用して、具体的.rstに文書化したいと考えていますA.B

私は試した:

成功せずに:

もちろんAモジュールではありません。それ以前のものはパッケージやモジュールとautoclass考えているようです。.

0 投票する
1 に答える
2629 参照

python - Sphinx autosummary ディレクティブのこの「生成された」オプションは何ですか?

generated/ライブラリの API を文書化するために sphinx-apidoc と autosummary 拡張機能を使用していますが、以下のオプションの目的を本当に理解できません。

これはSphinxのドキュメントであり、パンダのようなライブラリにあります。私は使用toctreeしていて、API は自動生成されていますが、何が生成されたのかわかりません。生成されたというフォルダーが表示されず、これの利点/目的がわかりません。

ありがとう

0 投票する
1 に答える
1686 参照

python - Sphinx の Python docstring で変数の型を指定するにはどうすればよいですか?

次のように、Python docstring でパラメーターのタイプを指定できます。

Sphinx の autodoc 機能を使用すると、これによりパラメーター リストが生成され、各パラメーターにはその型が適切にタグ付けされます。

しかし、インスタンス属性でこれを行うにはどうすればよいでしょうか? このようなもの

動作しません。の後に1 語の型を置くこともできます:ivarが、ここでは 3 つの単語で構成されているため、機能しません。

0 投票する
1 に答える
905 参照

python-sphinx - Sphinx autodoc TypeError: 'type' オブジェクトは反復可能ではありません

ドキュメント (任意のタイプ: html、man ページ、latexpdf...) をビルドしようとすると、sphinx はプロジェクトのサブディレクトリを autodoc しようとして失敗します。問題を絞り込むためにさまざまなアプローチを試みましたが、原因を見つけることができないようです。最初のファイルはすべて sphinx-apidoc によって生成されました。

ディレクトリ A には、次の最初のファイルがあります。

:members: ディレクティブを削除しても、エラーは発生しません。ファイル B または E が欠落している場合、または E 内のファイル B のインポートが欠落しているかコメントアウトされている場合も、エラーは発生しません。

fileB と fileE が単純に次のようにペアになっている場合でも、失敗します。

ファイル B:

ファイルE:

次のスタック トレースを使用します。

autodoc が読み込もうとしているファイルに何か問題があるのでしょうか、それとも autodoc 自体に問題があるのでしょうか? 私が試すことができる回避策はありますか?

ありがとう!