Автодок Сфинкса, включая классы и методы

У меня есть классы Python, и некоторые из них находятся в своих собственных файлах

т.е. userdata.py:

class userdata:
    """User input class for reading..."""

    def __init__(self, fname):
        self.fname = fname        


    def trykey(self,name,injson):
....

Я пробовал несколько методов, чтобы иметь возможность ссылаться на конкретный метод в этом классе в документации, но это не сработало.

Я генерирую автодок через команду

sphinx-apidoc 

Он генерирует только модули для кода выше

_lib.io package
=====================

Submodules
----------

.. toctree::

   lib.io.userdata

Module contents
---------------

.. automodule:: lib.io
    :members:
    :undoc-members:
    :show-inheritance:

Аналогичная проблема для модулей с несколькими классами, т.е. ad1.py

class inner1(inherited)
....
class inner2(inherited)
....def
....

автодок:

_lib.ad.ad1 module
===========================================

.. automodule:: lib.ad.ad1
    :members:
    :undoc-members:
    :show-inheritance:

Есть ли способ, чтобы автокласс и automethod генерировались автоматически?

0 ответов

Другие вопросы по тегам