python - 模块内的 Sphinx 自动文档功能

Question

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

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

因此，例如，如果我有一个名为的 python 文件test.py，并且在该文件中我有 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. 像这样：

The test module
===============

The test module contains...

.. currentmodule:: test

The foo function
----------------

.. autofunction:: foo

The bar function
----------------

.. autofunction:: bar