我想将reStructuredText,Sphinx和Sphinx autodoc用于Python代码,其方式与将Javadoc用于Java代码的方法相同,即用于指定参数和返回值,还用于链接到其他类,方法等。
我发现很难找到学习方法的参考。 Sphinx documentation顺带提及:param
和:return:
,仅作为字段列表的示例。我找不到适合这些角色的适当参考(以及我想像的类似角色,例如“另请参阅”)。
更重要的是,我发现不清楚如何为其他类和方法创建链接,特别是如果它们在其他包中。
这是Python开发人员从源代码提取文档的主要方法吗?如果是这样,我希望可以在某处找到一些明确的文档和参考。
更新:请注意,我不是指the autodoc reference。本页说明如何将文档字符串导入任意Sphinx文档。它确实解释了可以在文档字符串中使用哪些角色来记录参数,返回值,类型或链接到其他方法和类。例如,在此页面上搜索:param
找不到任何内容。
param
和return
,在“ Python域”部分的[信息字段列表]中进行了描述:https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists。