Simple way to convert Python docstrings from reStructured Text to Google style?

Question

Does anyone now a simple way do convert all docstrings in an existing project from reStructured Text to the Google format?

It looks like Napoleon can do something like that, but it looks very complicated, so I figured I'd ask if someone has done that before. Any idea would be much appreciated.

Steve Piercy · Accepted Answer · 2018-02-20T20:47:01.843

14

Try using pyment to convert docstrings from reStructuredText to Google format. Then use Napolean to generate documentation via Sphinx.

Napoleon is a pre-processor that parses NumPy and Google style docstrings and converts them to reStructuredText before Sphinx attempts to parse them.

edited Feb 20 '18 at 20:47

answered Jul 06 '17 at 18:58

Steve Piercy

13,693
1
44
57

The link you provided gives a 404. – edo Feb 20 '18 at 13:12
`Then use Napolean to generate documentation via Sphinx.` is not the part of the question. But thanks for the information since Sphinx couldn't accept google style directly. – Luk Aron Jan 18 '21 at 09:21
@LukAron the OP said "It looks like Napoleon can do something like that". I elaborated upon when to use Napoleon in my answer, specifically after using pyment. – Steve Piercy Jan 18 '21 at 10:04

score 4 · Answer 2 · answered Jul 05 '22 at 00:37

There is also docconvert at https://github.com/cbillingham/docconvert.

I personally found it did a much better job;

better indentation and line wrapping (personal choice)
coped with docstrings that were a mix of google and reSTructured styles in the same docstring!

Simple way to convert Python docstrings from reStructured Text to Google style?

2 Answers2