Python 如何在Sphinx文档中的某些特定函数之后插入图像?
我是斯芬克斯的新手。我使用autodoc生成了Python 如何在Sphinx文档中的某些特定函数之后插入图像?,python,image,python-sphinx,restructuredtext,autodoc,Python,Image,Python Sphinx,Restructuredtext,Autodoc,我是斯芬克斯的新手。我使用autodoc生成了.rst文件。以下是其中一个模块的.rst文件: 建筑用品 ===================== 行动 ---------------------------------- .. 自动模块::acat.build.actions :成员:func1、func2、func3 :观察员委员会成员: :显示继承: 模式 ---------------------------------- .. automodule::acat.build.patte
.rst
文件。以下是其中一个模块的.rst
文件:
建筑用品
=====================
行动
----------------------------------
.. 自动模块::acat.build.actions
:成员:func1、func2、func3
:观察员委员会成员:
:显示继承:
模式
----------------------------------
.. automodule::acat.build.patterns
:成员:func4、func5
:观察员委员会成员:
:显示继承:
订单
----------------------------------
.. 自动模块::acat.build.orderings
:成员:6
:观察员委员会成员:
:显示继承:
现在我想在func1
、func3
和func5
之后插入图像,我知道图像可以通过
.. image:: func1_example.png
但是,我应该将这些行放在哪里才能使图像显示在相应函数的正下方?假设您有一个模块,其中包含2个函数和3个文档字符串,例如:
acat.build.actions.py
"""
The module docstring.
"""
def func1():
"""
Docstring of func1.
"""
def func2():
"""
Docstring of func2.
"""
为了将图像准确插入所需位置,必须在.rst
文件中的准确位置声明图像。因此,您可以这样编写acat.build.actions.rst
:
建筑用品
=====================
行动
----------------------------------
.. 自动模块::acat.build.actions
:成员:
:排除成员:func1
:观察员委员会成员:
:显示继承:
.. 自动函数::func1
你可以在这里写一些文字。
.. image::func1_example.png
您可以使用:exclude members:func1
选项从模块中明确排除func1
因为您希望将图像包含在它的正下方。这允许您以自定义方式编写
func1
的文档,将从.py
文件中提取func1
的docstring,但您可以在其中写入所需的重构文本。如果要为更多函数执行此操作,请应用相同的技术。如果将该指令放入函数的docstring中,它是否放置在您想要的位置?问题是,我不希望这些与图像相关的行出现在源代码的docstring中。