模块中的Sphinx autodoc函数

Question

我刚开始使用狮身人面像并愿意学习。

我想将我的各种功能分解为index.rst文件中的不同部分。因此，每个函数都有其自己的标题。

例如，如果我有一个名为test.py的python文件，并且在该文件中，我有2个功能：

def foo():
    """This prints bar"""
    print("bar")

def bar():
    """This prints foo"""
    print("foo")

我如何在index.rst中将test.py文件中的两个功能分开？

:mod:`test` -- foo
.. automodule:: test.foo
   :members:
   :undoc-members:
   :show-inheritance: 
:mod:`test` -- bar
.. automodule:: test.bar
   :members:
   :undoc-members:
   :show-inheritance: 

如果我能弄清楚如何分开功能，那么在index.html中看起来更干净！现在，如果我只运行以下命令，则输出不是很干净：

:mod:`test` -- these are my functions
--------------------------------------------
.. automodule:: test
   :members:
   :undoc-members:
   :show-inheritance:

Answer 1

您可以使用autofunction。像这样：

autofunction