使用 Sphinx 和 Sphinx 的自动文档（如 Javadoc）所需的 reStructuredText 角色的参考在哪里？
Where is the reference for the reStructuredText roles needed for using Sphinx and Sphinx's autodoc like Javadoc?
我想将 reStructuredText、Sphinx 和 Sphinx autodoc 用于 Python 代码，就像将 Javadoc 用于 Java 代码一样，即用于指定参数和 return 值，也用于 link 到其他 类、方法等
我发现很难找到学习如何执行此操作的参考。 Sphinx documentation 顺便提及 :param 和 :return:，仅作为字段列表的示例。我无法在任何地方找到这些角色（以及我认为存在的类似角色，例如 "see also"）的合适参考。
更重要的是，我发现不清楚如何为其他 类 和方法创建 link，尤其是当它们在其他包中时。
这是Python开发人员从源代码中提取文档的主要方式吗？如果是这样，我希望在某个地方有一些明确的文档和参考资料。
更新：请注意，我不是指the autodoc reference。此页面解释了如何将文档字符串导入任意 Sphinx 文档。它 不 解释哪些角色可以在文档字符串中用于记录参数、return 值、类型，或 link 其他方法和 类 .例如，在此页面上搜索 :param 找不到任何内容。
可在文档字符串中使用的 param 和 return 等 ReST 字段在 "Python domain" 部分的 "Info field lists" 下进行了描述：https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists。 =15=]
可用于创建对记录的 Python 对象的交叉引用的角色在此处描述：https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-python-objects。
您还应该看看 Napoleon 扩展，它支持许多人认为更易读的文档字符串样式：https://sphinx-doc.org/en/master/usage/extensions/napoleon.html。
我想将 reStructuredText、Sphinx 和 Sphinx autodoc 用于 Python 代码，就像将 Javadoc 用于 Java 代码一样，即用于指定参数和 return 值，也用于 link 到其他 类、方法等
我发现很难找到学习如何执行此操作的参考。 Sphinx documentation 顺便提及 :param 和 :return:，仅作为字段列表的示例。我无法在任何地方找到这些角色（以及我认为存在的类似角色，例如 "see also"）的合适参考。
更重要的是，我发现不清楚如何为其他 类 和方法创建 link，尤其是当它们在其他包中时。
这是Python开发人员从源代码中提取文档的主要方式吗？如果是这样，我希望在某个地方有一些明确的文档和参考资料。
更新：请注意，我不是指the autodoc reference。此页面解释了如何将文档字符串导入任意 Sphinx 文档。它 不 解释哪些角色可以在文档字符串中用于记录参数、return 值、类型，或 link 其他方法和 类 .例如，在此页面上搜索 :param 找不到任何内容。
可在文档字符串中使用的 param 和 return 等 ReST 字段在 "Python domain" 部分的 "Info field lists" 下进行了描述：https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists。 =15=]
可用于创建对记录的 Python 对象的交叉引用的角色在此处描述：https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-python-objects。
您还应该看看 Napoleon 扩展，它支持许多人认为更易读的文档字符串样式：https://sphinx-doc.org/en/master/usage/extensions/napoleon.html。