Hello, Sphinx comes with a special extension called Napoleon: http://sphinx-doc.org/latest/ext/napoleon.html
Once enabled (normally in conf.py, when docu are generated) it makes Sphinx understand Google and Numpy docstrings. Best, Nikolay On Tuesday, November 24, 2015 at 3:49:06 PM UTC+3, Colin Marquardt wrote: > > Hi, > > we are trying to select a default docstring style in my company, which > means to decide between NumPy-style ( > http://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_numpy.html#example-numpy) > > and Google-style ( > http://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html#example-google) > > docstrings.. > > Personally, I like the Google style better since it's more concise. > Someone mentioned though that Spyder would support only the NumPy style, > and indeed the few references I can find point towards that (like > http://stackoverflow.com/a/24557076 and > http://stackoverflow.com/a/29636242). However, since Sphinx (Spyder's > rendering backend) needs an extension to understand NumPy style anyway (the > numpydoc extension, or Napoleon), it may not be so hard to support both > styles? > > Does anybody have experience with this? > > TIA > Colin > -- You received this message because you are subscribed to the Google Groups "spyder" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at https://groups.google.com/group/spyderlib. For more options, visit https://groups.google.com/d/optout.
