File: parsers.md

package info (click to toggle)
python-griffe 1.15.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,292 kB
  • sloc: python: 17,202; makefile: 47; sh: 24; javascript: 13
file content (43 lines) | stat: -rw-r--r-- 560 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# Docstring parsers

## **Main API**

::: griffe.parse

::: griffe.parse_auto

::: griffe.parse_google

::: griffe.parse_numpy

::: griffe.parse_sphinx

::: griffe.DocstringStyle

## **Parser options**

::: griffe.DocstringOptions

::: griffe.GoogleOptions

::: griffe.NumpyOptions

::: griffe.SphinxOptions

::: griffe.AutoOptions

::: griffe.PerStyleOptions

## **Advanced API**

::: griffe.Parser

::: griffe.parsers

::: griffe.parse_docstring_annotation

::: griffe.docstring_warning

::: griffe.DocstringDetectionMethod

::: griffe.infer_docstring_style