Sphinx中是否有标准或最佳实践为复合Python数据类型提供更准确的规范？例如，我有一个函数返回dict映射str到str并使用numpydoc样式。我应该做点什么：
Returns
-------
out : dict of str to str
或可能dict of str: str？
对于已知内容类型的列表，我注意到NumPy使用格式
foo : list of int
此常见用例是否有标准或最佳做法？
答案 0 :(得分：0)
我不确定这是否是最佳做法，但我通常会做:returns: dict( str=str )之类的事情。我认为这对你和你的项目最有效。如果您使用像PyCharm这样的东西，它会为您的doc字符串推荐“最佳”选项，但它会慢慢停止推荐，因为它会注意到您以不同方式执行操作。像PEP8这样的东西更像是指导方针（试图在这里尝试我最好的加勒比海盗印象），而不是那么难的规则。最重要的是你是否可以阅读它。
一个非常好的灵感来源是Python自己的文档。如果您正在浏览它并且您注意到一个漂亮的页面，请查看左侧栏并单击显示源，然后只复制该样式...我一直这样做:)
答案 1 :(得分：0)
旧问题，但仍然是搜索该信息时的热门话题之一。
经过更多搜索后，我在Sphinx docs中发现了这一点：
New in version 1.5.
Container types such as lists and dictionaries can be linked automatically using the
following syntax:
:type priorities: list(int)
:type priorities: list[int]
:type mapping: dict(str, int)
:type mapping: dict[str, int]
:type point: tuple(float, float)
:type point: tuple[float, float]