2013-07-21 5 views
7

ext.autodocを使用していくつかのPythonクラスを文書化し始めました。私は、コンテンツなどSphinx:TOCにクラスを表示する

======== 
mymodule 
======== 

.. automodule:: mymodule 
    .. autoclass:: myclassA 
     :members: 
    .. autoclass:: myclassB 
     :members: 

プラスindex.rstで数* .rstのファイルを持っている:

.. toctree:: 
    :maxdepth: 2 
    mymodule 

「のmymodule」内容の表に示されているが、私も見てみたいと思いますあまりにもTOCのクラス:

  • のmymodule
    • myclassA
    • メートル

yclassBは、どのように私はスフィンクスは、各クラスのセクションのようなものを作成することができますか?それともそうしないといい理由がありますか?

ありがとう

答えて

3

スフィンクスはセクションを作成できません。 .rstファイルに自分自身を追加する必要があります。このような何か:面白いかもしれませんいくつかの代替提案を

myclassA 
-------- 

.. autoclass:: myclassA 
    :members: 

myclassB 
-------- 

.. autoclass:: myclassB 
    :members: 

、これらの質問(と回答)を参照してください。

関連する問題