File: numpy.md

package info (click to toggle)
mkdocstrings-python-handlers 1.16.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,228 kB
  • sloc: python: 3,496; javascript: 84; makefile: 37; sh: 17
file content (11 lines) | stat: -rw-r--r-- 513 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
 
# Numpydoc style

## :warning: Work in Progress!

NOTE: As Numpy-style is partially supported by the underlying parser,
you may experience problems in the building process if your docstring
has a `Methods` section in the class docstring
(see [#366](https://github.com/mkdocstrings/mkdocstrings/issues/366)).

See [Numpydoc's documentation](https://numpydoc.readthedocs.io/en/latest/format.html).
See the supported docstring sections on [Griffe's documentation](https://mkdocstrings.github.io/griffe/docstrings/).