如何让 Sphinx 识别 `:param` 元素?
How to make Sphinx recognize the `:param` element?
我想用Sphinx生成html个文档,虽然可以生成成功,但是Sphinx不识别:param content:
.
这样的元素
错误的文件
正确的文件
这里可以看到具体的代码文件,使用. \make.bat html
生成文档:Shared/sphinx-document-generation at master - Andy-AO/Shared
查看了autodoc
扩展的文档,还是没有找到相关的设置,可能是我遗漏了一些重要的东西。
为什么会这样?如何让 Sphinx 识别这些元素?
感谢@mzjn,问题已经解决,是reStructuredText格式不对
其他内容和Field列表之间要有一个空行
×
"""
describe
:param child_node: this is child_node
√
"""
describe
:param child_node: this is child_node
Field与Field内容之间要有空格
- × -
:param content:the object to be added
- √ -
:param content: the object to be added
我想用Sphinx生成html个文档,虽然可以生成成功,但是Sphinx不识别:param content:
.
错误的文件
正确的文件
这里可以看到具体的代码文件,使用. \make.bat html
生成文档:Shared/sphinx-document-generation at master - Andy-AO/Shared
查看了autodoc
扩展的文档,还是没有找到相关的设置,可能是我遗漏了一些重要的东西。
为什么会这样?如何让 Sphinx 识别这些元素?
感谢@mzjn,问题已经解决,是reStructuredText格式不对
其他内容和Field列表之间要有一个空行
×
""" describe :param child_node: this is child_node
√
""" describe :param child_node: this is child_node
Field与Field内容之间要有空格
- × -
:param content:the object to be added
- √ -
:param content: the object to be added
- × -