2016-10-16 4 views
5

私は、Python 3モジュールのHTMLドキュメントを、その関数のreStructuredTextドキュメンテーションから、Sphinx(HTMLを作成)を使って自動的に生成しています。生成されたHTMLドキュメントはこれまでのところよく見えますが、ソースコードにPEP484 type hintsとして与えられている関数シグネチャのパラメータタイプは正しく表示されません。Python 3:Sphinxがタイプヒントを正しく表示しない

など。これは私の機能の一つのスフィンクス、生成されたHTMLドキュメントからいくつかの出力例です:

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 

これは、私はそれが見えるように期待するものです。

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 

これは、実際にどのようにPythonのコードです次のようになります。

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 [] 

私はSphinxにPython 3タイプのヒントを正しく表示させるにはどうすればいいですか?

+1

タイプをdocstringに入れることはオプションではありませんか?戻り値の型として ':param str filename:...'と ':rtype:list'を返します。 – Bakuriu

+0

これは冗長になり、プロジェクトの人々は型を2回変更することを考えません。また、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)を参照してください。 –

関連する問題