让我们想象一下，我想看到一个简单方法的文档字符串弹出窗口PyCharm4.5 社区版（也在 5.0 中尝试过）。
我在两个文件中都写下了这些文档字符串epytext语法（自 2008 年起不再支持 Epydoc 生成器，并且仅适用于 Python2）和重构文本语法（Sphinx 使用 - 积极支持的生成器，用于官方 python 文档）
epytext 在 PyCharm 文档弹出窗口中完美运行
PyCharm 可与 epytext 配合使用 https://i.stack.imgur.com/xTJbX.png
但 reStructuredText 根本不显示任何参数！
PyCharm 失败并显示 reStructuredText 屏幕截图 https://i.stack.imgur.com/8lD8l.png
尝试使用 PyCharm 设置来处理此问题、阅读 PyCharm 帮助、搜索 PyCharm bugtracker 并使用 Google 都无法帮助我找到 PyCharm 中的这些文档字符串弹出窗口无法与社区推荐的文档字符串标记语言一起正常工作的原因。
这是因为该功能的需求低吗？也许，是否有一些有用的替代方法可以在 PyCharm 甚至其他 IDE 中查看现代文档标记？我还需要能够生成 HTML 格式漂亮的文档页。
我发现了另一个话题 https://stackoverflow.com/questions/31796481/documenting-python-parameters-in-docstring-using-pycharm这里，涉及同一问题，但自去年以来仍未得到答复。所以，我猜测我想要在现代 IDE 中查看现代文档的愿望出了什么问题。
这是我的代码示例
def find_links(self, issue, link_type):
"""
Find all issues linked with C{issue} with C{link_type}.
@param issue: Issue key
@type issue: str
@param link_type: Accepts either Type Name (like 'Child') or Link Description (like 'child of')
@type link_type: str
@return: Keys of found issues
@rtype: list
"""
result_keys = []
link_list = self.get_link_list(issue)
for link in link_list:
... # omitted
return result_keys
def test_sphinx_docs_method(self, issue, link_type):
"""
Find all issues linked with *issue* with *link_type*.
:param issue: Issue key
:type issue: str
:param link_type: Accepts either Type Name (like 'Child') or Link Description (like 'child of')
:type link_type: str
:return: Keys of found issues
:rtype: list
"""
result_keys = []
link_list = self.get_link_list(issue)
for link in link_list:
... # omitted
return result_keys
