Sphinx autodoc包括类和方法

时间:2018-11-18 08:22:21

标签: python python-sphinx autodoc sphinx-apidoc

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

autodoc:

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

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

是否有一种方法可以自动生成自动分类和自动方法。

0 个答案:

没有答案