Python sphinx 其中是使用Sphinx和Sphinx'所需的重构文本角色的参考；autodoc和Javadoc一样吗？

我希望对Python代码使用StructuredText、Sphinx和Sphinx autodoc，就像对Java代码使用Javadoc一样，也就是说，用于指定参数和返回值，但也用于链接到其他类、方法等

我发现很难找到学习如何做到这一点的参考。顺便提及

：param

和

：return:

，仅作为字段列表的示例。我在任何地方都找不到这些角色（以及我想象中存在的类似角色，例如“请参阅”）的适当参考

更重要的是，我发现不清楚如何为其他类和方法创建链接，特别是如果这些类和方法在其他包中的话

这是Python开发人员从源代码中提取文档的主要方式吗？如果是这样的话，我希望有一些明确的文档和参考

---

更新：请注意，我不是指。本页介绍如何将docstring导入任意Sphinx文档。它没有解释可以在docstring中使用哪些角色来记录参数、返回值、类型或链接到其他方法和类。例如，在此页面上搜索

：param

找不到任何内容。

可以在docstring中使用的ReST字段，如

param

和

return

，在“Python域”部分的“信息字段列表”中进行了描述：

此处描述了可用于创建对文档化Python对象的交叉引用的角色：

---

您还应该看看Napoleon扩展，它支持许多人认为更清晰的docstring样式：。

@StevePiercy，这听起来很合理，但并不能真正回答问题。请参见问题末尾的更新。

：param:

，

：return:

等：链接到类等：还可以看看Napoleon扩展，它支持许多人认为更清晰的docstring样式：