Всплывающие окна документации PyCharm и reStructuredText (Sphinx) ⇐ Python

[Anonymous]

Предположим, я хочу увидеть всплывающее окно со строкой документации для одного простого метода в PyCharm 4.5 Community Edition (пробовано также в версии 5.0).

Я записал эти строки документации как в синтаксисе epytext (генератор Epydoc не поддерживается с 2008 года и работает только для Python2), так и в синтаксисе epytext Синтаксис reStructuredText (который используется Sphinx — активно поддерживаемым генератором, используемым для официальной документации Python)

Синтаксис epytext отлично работает во всплывающих окнах документации PyCharm

PyCharm работает со снимком экрана epytext

Но синтаксис reStructuredText вообще не показывает никаких параметров!

PyCharm не работает со снимком экрана reStructuredText

Попытка решить эту проблему с помощью настроек PyCharm, чтение справок PyCharm, поиск в системе отслеживания ошибок PyCharm и использование Google не помогли мне найти причину, по которой эти всплывающие окна со строками документации в PyCharm не работают правильно с рекомендованным сообществом языком разметки строк документации.

Это из-за низкого спроса на эту функцию? Возможно, есть ли какие-нибудь полезные альтернативы для просмотра современной разметки документации внутри PyCharm или даже другой IDE? Мне также нужно иметь возможность генерировать HTML-страницы документации в красивом формате.

Я нашел здесь еще одну тему, связанную с той же проблемой, но с прошлого года она до сих пор остается без ответа. Итак, я догадываюсь, что не так с моим желанием просматривать современную документацию внутри современной 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


Подробнее здесь: https://stackoverflow.com/questions/392 ... ion-popups