2016-08-30 5 views
2

PyCharm 4.5 Community Edition (하나의 간단한 방법에 대한 docstring 팝업을보고 싶습니다. 5.0에서도 사용). (- offical 한 파이썬 문서에 사용 적극적으로 지원 발전기, 스핑크스에 의해 사용되는)PyCharm 및 reStructuredText (Sphinx) 문서 팝업

나는 (Epydoc 발생기는 2008 년 이후 지원되지 않으며 단지 Python2 작동) 및 reStructuredText 구문 모두 epytext 구문이 문서화 문자열을 적어

epytext 하나는 완벽하게

PyCharm works with epytext Screenshot

PyCharm 문서 팝업에서 작동하지만 reStructuredText의 하나는에서 매개 변수를 표시하지 않습니다 어서! PyCharm를 읽고 PyCharm 설정으로이 문제를 처리하기 위해 노력

PyCharm fails with reStructuredText Screenshot

는 PyCharm의 bugtracker를 통해 검색 및 PyCharm 이러한 문서화 문자열 팝업이 제대로 작동하지 않는 이유를 찾아 내게 도움이되지 수있는 구글을 사용하는 데 도움이 커뮤니티가 권장하는 docstring 마크 업 언어.

기능 요구가 적습니까? 아마도 PyCharm 또는 다른 IDE에서 현대 문서 마크 업을 볼 수있는 유용한 대안이 있습니까? 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 

답변

1

만 최근 PyCharm 버전에 존재하는이 기능은 버전을, 그래서 당신이 경우 나도 몰라? 내 PyCharm CE 2016.2.2에서는 스크린 샷과 비슷합니다.

enter image description here

확인 환경 설정> 편집기> 일반> 코드 완성이 확인 옵션 "Autopop 설명서"로 사용할 수 있습니다.

행운을 빈다.

+0

대단히 감사합니다! 이상하지만, 현재 pycharm 사이트에서 2016.1 버전을 다운로드해도이 기능이 작동하고 몇 달 전에 제 동료가 설치 한 버전은 작동하지 않습니다! IDK 정확한 이유는 아마 모든 thses 버전에 대한 최신 패치가 제공됩니다 (필자는 5.0.2와 5.0.5를 테스트했으며 최신 기능도이 기능과 함께 작동합니다!). –

관련 문제