Sfinks: Spraw, aby klasy pojawiły się na TOC

Question

Zaczynam dokumentować kilka klas Pythona za pomocą ext.autodoc. Mam kilka plików * .rst z treści takich jak

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

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

plus pewne index.rst:

.. toctree:: 
    :maxdepth: 2 
    mymodule 

„mymodule” pokazanym w spisie treści, ale też bym chciał zobaczyć zajęcia w TOC tOO:

• mymodule
  • myclassA
  • m yclassB

Jak mogę dokonać sfinks stworzenie czegoś podobnego sekcji dla każdej klasy? Czy jest jakiś dobry powód, aby tego nie robić?

dziękuję

Answer 1

Sfinks nie może tworzyć sekcji. Musisz dodać je samodzielnie w pliku .rst. Coś takiego:

myclassA 
-------- 

.. autoclass:: myclassA 
    :members: 

myclassB 
-------- 

.. autoclass:: myclassB 
    :members: 

Dla niektórych alternatywnych sugestii, które mogą być interesujące, zobaczyć te pytania (i odpowiedzi):

• Sphinx customizing autoclass output
• Sorting display by class using sphinx with 'autodoc'?