86

Does PyCharm 2.7 (or will PyCharm 3) have support for custom docstring and doctest stubs? If so, how does one go about writing this specific type of custom extension?

My current project has standardized on using the Google Python Style Guide (http://google-styleguide.googlecode.com/svn/trunk/pyguide.html). I love PyCharm's docstring support, but it's only two supported formats right now are epytext and reStructureText. I want, and am willing to write myself, a PyCharm plugin that creates a documentation comment stub formatted in either Google or Numpydoc style (https://pypi.python.org/pypi/sphinxcontrib-napoleon/). Of special importance here is incorporating the type inference abilities that PyCharm has with the other two documentation types.

bad_coder
  • 11,289
  • 20
  • 44
  • 72
kalefranz
  • 4,612
  • 2
  • 27
  • 42

3 Answers3

115

With PyCharm 5.0 we finally got to select Google and NumPy Style Python Docstrings templates.

It is also mentioned in the whatsnew section for PyCharm 5.0.

How to change the Docstring Format:

File --> Settings --> Tools --> Python Integrated Tools

There you can choose from the available Docstrings formats:

Plain, Epytext, reStructuredText, NumPy, Google

As pointed out by jstol: for Mac users, this is under

PyCharm -> Preferences -> Tools -> Python Integrated Tools.

Nras
  • 4,251
  • 3
  • 25
  • 37
  • 9
    For Mac users, this is under PyCharm -> Preferences -> Tools -> Python Integrated Tools. – jstol Jul 26 '16 at 20:55
  • 3
    Any idea how to make this selection stick when I start a new project? It's a pain to have to hunt down this setting every time. – superbeck Sep 01 '17 at 03:36
  • 1
    Consider updating this answer to include info in comment from jstol – Kane C Mar 06 '18 at 19:44
4

As CrazyCoder mentions, its a ticket. Right now, you can only use EpyType and reStructuredText.

Games Brainiac
  • 80,178
  • 33
  • 141
  • 199
1

Just to be make @Nras answer explicit, as of PyCharm 5.0:

File > Settings > Tools > Python Integrated Tools > Docstrings > Google

Kamil Sindi
  • 21,782
  • 19
  • 96
  • 120