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

user_6330511 0
Viewed 5738

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.

google-style-guide sphinx-napoleon docstring python-sphinx python
2 Answers

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!
user_13314460
Related