python - Read the Docs に、特別メンバー向けの autodoc ドキュメントを含めますか?

Question

文書化された 2 つのグローバル スペシャル メンバーを含むモジュールがあります。

Sphinx をローカルで実行すると、ドキュメントを含むドキュメントが作成されますが、Read the Docs は作成されません。代わりに、組み込み型のドキュメントを使用します。

私は両方のスタイルを試しました:#:定義の後に docstring 。私は のドキュメントを何度も読んだことがautodocあります。Read the Docsにビルドエラーさえ表示されないため、何が欠けているのかわかりません。

何か案は？

Answer 1

Napoleon 拡張機能を使用して NumPy または Google スタイルのドキュメント文字列を処理している場合は、conf.py でこの設定フラグを設定できます。

http://sphinx-doc.org/ext/napoleon.html?highlight=special#confval-napoleon_include_special_with_doc

私の記憶が正しければ、autodoc のディレクティブもあります。

http://sphinx-doc.org/ext/autodoc.html?highlight=member#event-autodoc-skip-member

このメソッドを実装することで、ドキュメントに含めるメンバーと含めないメンバーを細かく選択できます。