web-dev-qa-db-ja.com

カスタムPyCharm docstringスタブ(つまり、Google docstringまたはnumpydoc形式用)

PyCharm 2.7(またはPyCharm 3)は、カスタムdocstringおよびdoctestスタブをサポートしていますか?もしそうなら、この特定のタイプのカスタム拡張機能をどのように書きますか?

私の現在のプロジェクトは、Google Python Style Guide( http://google-styleguide.googlecode.com/svn/trunk/pyguide.html )。PyCharmのdocstringサポートが大好きですが、現在サポートされている形式はepytextとreStructureTextの2つのみです。 GoogleまたはNumpydocスタイルのいずれか( https://pypi.python.org/pypi/sphinxcontrib-napoleon/ )ここで特に重要なのは、 PyCharmが他の2つのドキュメントタイプで持つタイプ推論機能。

66
kalefranz

PyCharm 5.0では、ようやく GoogleおよびNumPyスタイルPython Docstrings テンプレートを選択するようになりました。

PyCharm 5.0の whatsnew セクションにも記載されています。

Docstring形式の変更方法:

ファイル->設定->ツール-> Python統合ツール

使用可能なDocstrings形式から選択できます。

プレーン、Epytext、reStructuredText、NumPy、Google

Jstolが指摘したように、Macユーザーの場合、これは

PyCharm->設定->ツール-> Python統合ツール。

89
Nras

CrazyCoderが述べているように、その ticket です。現時点では、EpyTypereStructuredTextのみを使用できます。

4
Games Brainiac

PyCharm 5. の時点で、@ Nrasの回答を明示的にするだけです。

ファイル>設定>ツール> Python Integrated Tools> Docstrings> Google

1
ksindi