-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Milestone
Description
I have decided we will eventually use Sphinx, so from now on, please use NumPy style for creating new docstrings. When possible, change existing docstrings to this style also.
NumPy docstrings styleguide: https://numpydoc.readthedocs.io/en/latest/format.html
NumPy docstrings examples: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html
Sphinx: https://www.sphinx-doc.org/en/master/
By the way, it supports LaTex via mathjax I think, check for instance airy function from:
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request