Предположим, что я хочу увидеть всплывающее окно docstring для одного простого метода в PyCharm 4.5 Community Edition (проверено также в 5.0).Документация по документу PyCharm и reStructuredText (Sphinx)
Я записал эти строки документации в обеих epytext синтаксиса (Epydoc генератор не поддерживается с 2008 года и работает только для python2) и ReStructuredText синтаксиса (который используется Сфинкс - активно поддерживаются генератор, используемый для OFFICAL питона документации)
epytext один работает в PyCharm документации всплывающих окон отлично
PyCharm works with epytext Screenshot
Но ReStructuredText один не показывает каких-либо параметров в точке А LL!
PyCharm fails with reStructuredText Screenshot
Пытаясь справиться с этим с настройками PyCharm, чтение PyCharm помогает, поиск через PyCharm багтрекере и с помощью Google не может помочь мне найти причину, почему эти всплывающие окна в строку документации PyCharm не работают правильно с рекомендованным сообществом языком разметки docstring.
Это из-за низкого спроса на эту функцию? Возможно, есть ли какие-то полезные альтернативы для просмотра современной разметки документации внутри PyCharm или даже другой среды IDE? Я также должен иметь возможность генерировать HTML-файлы, отформатированные в формате HTML.
Я нашел another topic здесь, относящийся к одной и той же проблеме, но до сих пор остается без ответа с прошлого года. Итак, я догадываюсь, что не так с моими желаниями рассмотреть современную документацию в современной среде 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
Большое спасибо! Странно, но если скачать даже версию 2016.1 с сайта pycharm, в настоящее время эта функция работает, и тот, который мой коллега установил несколько месяцев назад, не будет! Точные причины IDK, вероятно, наступает недавний патч для всех версий thses (я тестировал 5.0.2 и 5.0.5, а последний работает с этой функцией тоже!) –