スフィンクスで自動的にdocクラスのToctreeを作成する

私のライブラリの1つでドキュメントを増やす予定です。私はドキュメント作成のためにsphinxを使っていましたが、最近はautodoc拡張を探っていました。スフィンクスで自動的にdocクラスのToctreeを作成する

ほとんどのプロフェッショナルなドキュメントのように、各クラスのドキュメントページには、すべてのドキュメント化されたメソッドのリストがあり、上部にリンクがあります。つまり、最上位のtoctreeには、それぞれ深いメソッドのドキュメントへのハイパーリンクがあります。

autodocで文書化されているクラスごとにこのtoctreeを自動的に作成する方法はありますか？スフィンクスのためのあなたのconf.pyファイルで

出典

2016-01-01 Ben Hoff

これは興味深いかもしれません：http://stackoverflow.com/q/14606348/407651 – mzjn

@mzjn、それは興味深いものですが、私は部分的に実装しました。しかし、私はまだスタブ内のクラスのドキュメントのトップにtoctreeを得ることができません。 –

ああ、nvm私は混乱していた。私はそれが働くようになった！回答を投稿したい場合は、私はそれを受け入れます。さもなければ私は後世のために投稿します。 –

は私index.rstにtoctreeを入れ

extensions = ['sphinx.ext.autosummary',] 
# NOTE: Don't overwrite your old extension list! Just add to it! 

autodoc_default_flags = ['members'] 
autosummary_generate = True

追加し、それは次のようになります。

..autosummary:: 
    :toctree: stubs 

    Class1 
    Class2 
    Class3

conf.py設定

ため this exampleを参照してください。 toctreeの例としては、

およびthis exampleです。

希望に役立ちます！

出典

2016-11-25 16:54:46

スフィンクスで自動的にdocクラスのToctreeを作成する

答えて

関連する問題