Pythonのスフィンクスのドキュメントにモジュール/クラス/関数本体の文書化
-
11-09-2019 - |
質問
autodocの機能を持つ(コードそのもの)を出力する関数やクラス身体Sphinxのドキュメントを持つ方法はありますか?私は多くの成功にautodocのを使用しています。私はそれはあなたのソースを表示する各機能のためにクリックするリンクのようにしたいドキュメントに引き込ま取得ドキュメンテーション文字列に加えて...可能ということでしょうか?
これは私の文書のほとんどは、今どのように見えるかについてです。
.. module:`foo.mymodule`
Title
===================
.. automodule:: foo.mymodule
.. autoclass:: MyModulesClass
:members:
:undoc-members:
解決
これはまだ問題にした場合: viewcode拡張子がには、これを行うことができますが、スフィンクスの開発版(1.0)が必要です。
他のヒント
私はそう信じていません。 autodocのソースコードからドキュメントを引っ張るだけである。
所属していません StackOverflow