問題タブ [autodoc]

Sphinx 機能を使用してautodoc、Python ライブラリのドキュメント文字列に基づいてドキュメントを生成しています。

相互参照の構文はここにあります

ドキュメントの他の領域からセクションを参照できるようにするには、セクションの前にラベルを付ける必要があります。

私が持っているのは、私のクラスの 1 つの .rst (ReStructeredText) ファイルです。それは使用しています

クラスのドキュメントを生成します。

私の質問は、ドキュメント内の別の .rst ドキュメントからクラスの自動生成されたメソッドを参照するにはどうすればよいですか? メソッドの docstring 内にラベルを配置しようとすると、Sphinx が文句を言います。メソッドの見出しの前にラベルを付けようとしても、Sphinx はそれを認識しません。

これを行う簡単な方法はありますか、またはクラスファイルにメソッド名を明示的に記述し、その前にラベルを付ける必要がありますか?

[Python ドキュメント2内の参照の例を次に示します。必要なことを実行しています (確かなことはわかりませんが、autodoc 機能を使用していると想定しています)。

私は関数を作成するモジュールを持っているのでchain(のように振る舞う)、インターフェイスを模倣して関数も公開itertools.chainしようと思いました。そのためには、別の関数を定義して、次のように貼り付けます。itertoolschain.from_iterablechain

そしてどこか_create_chain：

との両方chainにdocstrings があり、すべて正常に動作しますが、Sphinx でと の両方を自動的chain.from_iterableにドキュメント化したいと考えています。今、私は持っていますchainchain.from_iterable

のドキュメントを作成しますが、別のディレクティブをchain追加すると、モジュールと見なされるため、結果は になります。autofunctionchain.from_iterableImportErrorchain

chain.from_iterableこのシナリオにドキュメントを含めるにはどうすればよいですか?

だから私はそのようなことをすることを決意しています：

私は欲しい

しかし、

したがって、各関数、メソッド、およびクラスについて何かを記述する必要がありますが、同時に、コードで作成したすべての新しい関数が、ドキュメントを編集せずにドキュメントに表示される必要があります。することは可能ですか？

インスタンス変数を文書化するとき、私はできる

これは並列割り当てでは機能しません

並列代入で変数を文書化するにはどうすればよいですか?

jsdoc を使用してコールバックを適切に文書化するための最良の方法を探してインターネットを精査するのにかなりの時間を費やしましたが、残念ながら、まだ優れた方法を見つけていません。

これが私の質問です：

開発者向けの Node.js ライブラリを作成しています。このライブラリは、開発者が使用する複数のクラス、関数、およびメソッドを提供します。

私のコードを明確で理解しやすいものにするため、そして将来的にいくつかの API ドキュメントを (できれば) 自動生成するために、コードでjsdocを使用して何が起こっているかを自己文書化するようになりました。

次のような関数を定義するとします。

jsdoc を使用して、現在、この関数を次のように文書化しています。

コールバック関数が何を受け入れるかを絶対的に指定する方法がないため、上記のソリューションはちょっとハックっぽい気がします。

理想的には、次のようなことをしたいと思います:

上記は、コールバックが受け入れる必要があるものをより簡単に伝えることができるように思えます。それは理にかなっていますか？

私の質問は単純だと思います.jsdocでコールバック関数を明確に文書化する最良の方法は何ですか?

お時間をいただきありがとうございます。

autodoc を使用していくつかの関数を文書化しました。ローカルではうまく機能します。GitHub に commit すると、ドキュメントは ReadTheDocs でビルドされますが、「automodule」でドキュメント化した機能はありません。

私はconf.pyに追加しました：

しかし、それは役に立ちません。

これは、私が独自の C ライブラリを使用しているという事実に関連している可能性がありますか? （.soを取得するためにコンパイルする.cファイルがあります）

sphinx と sphinx の autodoc 機能を使用して Python プログラムを文書化しようとしていますが、次の形式でインポートを行う 1 つのファイルに問題があります。

一部の関数 (つまり、SQLAlchemy の asc、and_ および select) については、sphinx はモジュールのドキュメントにもドキュメントを追加します。驚くべきことは、これらの 3 だけであるということです。私は同じモジュールにクラス SafeConfigParser を問題なくインポートしています。また、この問題なしで math モジュールから関数をインポートする別のモジュールがあります。

詳細については、.rst ファイルは次のようになります。

どんな助けでも大歓迎です、事前に感謝します!

モジュールを文書化するために ( and と組み合わせて) を使用しようとしていますが、基本的なセットアップの後、実行するsphinxと、docstrings が含まれていない基本的な html のみが生成されます。私は Python 3.3 を実行しています。プロジェクト構造の概要は次のとおりです。autodocnumpydocmake html

__init__.py空で、追加conf.pyしたdocs/sourceディレクトリにありますsys.path.insert(0, os.path.abspath('../..'))

ディレクトリで実行make htmlするとdocs、次の出力が得られます。

それで、私は何を間違っていますか？

プロジェクトの文書化にsphinxを使用していますが、デコレータにラップされた関数に問題があります。同様の質問が寄せられているのを見たことがありますが、私の問題に合った解決策はないようです

パラメータを受け入れることができるカスタムデコレータにすべてラップされた何百もの関数があります

私の関数は次のようになります

sphinx と autodoc を使用してドキュメントを生成すると、CustomFunctionDecorator にラップされたすべての関数が sphinx ドキュメントの関数の実際の引数を隠し、このように表示されます。

テスト ドキュメント

ドキュメントは機能しますが、関数のパラメーターは機能しません....

何か案は？私が自分自身を明確にしたことを願っています