-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support Sphinx docstyle #25
Comments
You may already be aware but Sphinx can support Numpy or Google Style Docstrings with the Napoleon extension. I believe you can pip install it, add the extension to your |
I am aware, unfortunately my company insists upon this particular docstring format. |
My condolences 😉 I know this isn't what you wanted, but you might give If you are willing to ditch Atom, there is also the Both of these tools support the Sphinx/reST style. |
And yes I saw that VScode has a plugin to do the format I want (and so does |
I will add the new style, so need to change to VScode. |
@guillochon |
@spadarian I have one requested thing to add: A checkbox option to separate param description and type, like so:
This is immensely helpful already though! |
As described here: http://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists
The text was updated successfully, but these errors were encountered: