Custom PyCharm docstring stubs (i.e. for google docstring or numpydoc formats)

python pycharm docstring doctest sphinx-napoleon
kalefranz picture kalefranz · Sep 6, 2013 · Viewed 18.1k times · Source

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.

Answer

Nras picture Nras · Nov 3, 2015

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.

Related questions

How to auto-generate the type of a field in a docstring in PyCharm?

When I create a function with parameters, PyCharm offers me to create the docstring with :param param_name: field, which is pretty good. But I also need to add the :type param_name:. So from that : def foo(bar, xyz): …

Read More
Documenting `tuple` return type in a function docstring for PyCharm type hinting

How can I document that a function returns a tuple in such a way that PyCharm will be able to use it for type hinting? Contrived example: def fetch_abbrev_customer_info(customer_id): """Pulls abbreviated customer data from the …

Read More
How do I use installed packages in PyCharm?

In PyCharm, I've added the Python environment /usr/bin/python. However, from gnuradio import gr fails as an undefined reference. However, it works fine in the Python interpreter from the command line. GNURadio works fine with python outside of Pycharm. …

Read More