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

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

0 голосов
/ 18 ноября 2018

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

т.е. userdata.py:

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

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


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

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

Я генерирую autodoc с помощью команды 

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
....

autodoc: 

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

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

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

...