本文共 972 字，大约阅读时间需要 3 分钟。

在 Python Sphinx 中，自动生成成员函数的摘要是一个实用的功能。以下是实现这一需求的具体步骤：

project = 'Example'copyright = '2022, Example Company'author = 'John Doe'extensions = [    'sphinx.ext.autodoc',]autodoc_default_options = {    'members': True,}

2. 在 index.rst 文件中通过以下方式包含你的模块：

.. automodule:: example    :members:

运行 sphinx-build 命令后，Sphinx 会自动生成每个成员函数的摘要。这些摘要将整合到生成的文档中。

3. 如果需要直接包含模块和函数，可以在 example.rst 文件中添加如下内容：

.. include:: ../example/__init__.rst.. automodule:: example    :members:.. autofunction:: example.my_function

4. 对于类，你可以使用 .. autoclass:: 命令自定义摘要：

.. autoclass:: example.MyClass    :members:

5. 如果需要测试用例，可以在 test_example.py 中编写测试函数，并在 conf.py 中设置 autodoc_mock_imports 参数，避免生成文档时的导入错误：

autodoc_mock_imports = ['example.third_party']

6. 如果使用人工智能大模型生成摘要，可以在 conf.py 中设置 summary_length 参数来控制摘要长度：

autodoc_default_options = {    'members': True,    'summary_length': 200,}

最后，运行以下命令生成文档：

cd docs/sphinx-build -b html . _build/html

转载地址：http://ohafk.baihongyu.com/