2016-10-16 1 views
5

저는 스핑크스 (HTML 작성)를 사용하여 함수의 reStructuredText 문서 문자열에서 자동으로 파이썬 3 모듈의 HTML 문서를 생성합니다. 생성 된 HTML 문서는 지금까지는 괜찮아 보이지만, 소스 코드에서 PEP484 type hints으로 주어진 함수 시그니처의 매개 변수 유형은 올바르게 표시되지 않습니다.Python 3 : 스핑크스가 타입 힌트를 올바르게 표시하지 않습니다.

예.

static parse_from_file(filename: str) → list 
    Parses stuff from a text file. 

    Parameters: filename – the filepath of a textfile to be parsed 
    Returns:  list of parsed elements 

이 내가 그것을 모습을 기대하는 것입니다 :이 제 기능을 하나의 스핑크스 - 생성 된 HTML 문서에서 몇 가지 예제 출력

static parse_from_file(filename) 
    Parses stuff from a text file. 

    Parameters: filename (str) – the filepath of a textfile to be parsed 
    Returns:  list of parsed elements 
    Return type: list 

이 얼마나 파이썬 코드를 실제로 모양은 다음과 같습니다.

def parse_from_file(filename: str) -> list: 
    """Parses stuff from a text file. 

    :param filename: the filepath of a textfile to be parsed 
    :returns: list of parsed elements 
    """ 
    return [] 

어떻게 스핑크스가 Python 3 유형 힌트를 올바르게 표시 할 수 있습니까?

+1

유형을 docstring에 넣는 것은 옵션이 아닙니까? 반환 유형에 대해': param str filename : ...'과': rtype : list'이 있습니다. – Bakuriu

+0

그러면 프로젝트가 중복되어서 사람들이 두 번 타입을 변경하는 것에 대해 생각하지 않을 것입니다. 게다가 Sphinx가 PEP484 타입 힌트를 지원하는 것처럼 보입니다 : https://github.com/sphinx-doc/sphinx/issues/1968 –

답변

5

나는 sphinx-autodoc-typehints extension을 사용하여 독자적으로 해결했습니다.

+0

이 확장 기능은 현재'__init __()'클래스가없는 클래스에서는 작동하지 않습니다. Python 3.6 - [my ticket] (https://github.com/agronholm/sphinx-autodoc-typehints/issues/12)을 참조하십시오. –