Python 问题求助：如何让 Sphinx 识别出“参数”和“返回值”这类文档重要元素？

[AndyAO]

我想使用 Sphinx 来生成 html 文档，虽然可以成功生成，但识别不了像:param content:这样的元素，这些内容都被识别为文本，可读性极差。

在这里可以看到具体的代码文件，使用.\make.bat html可以生成文档： Shared/sphinx-document-generation at master · Andy-AO/Shared

为什么会出现这种情况？如何才能让文档生成器识别这些元素？

查看过autodoc扩展的文档之后，还是没有能够找到相关的设置，可能是我忽略了某些重要的内容。

有人遇到过这种情况吗？可能的原因是什么？

问题已经解决，是 reStructuredText 的格式有问题

1. Description和元素之间要有空行

   ×

   		"""
   		describe
   			:param child_node: this is child_node
   

   √

   		"""
   		describe
   
   		:param child_node: this is child_node
   

2. 元素和元素的内容之间要有空格

   • × - :param content:需要添加的对象
   • √ - :param content: 需要添加的对象