Skip to content

Commit e7ffb08

Browse files
authored
Merge pull request #301 from machow/docs-docstring-styles
docs: configuring docstring styles
2 parents 0205d17 + c1c6abd commit e7ffb08

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed
Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
---
2-
title: numpydoc style
2+
title: Docstring formats
33
jupyter:
44
kernelspec:
55
display_name: Python 3 (ipykernel)
66
language: python
77
name: python3
88
---
99

10-
quartodoc expects numpydoc style for docstrings.
10+
quartodoc prefers numpy style for docstrings, but can support other styles by configuring parser in your [quartodoc site options](./basic-docs.qmd) of `_quarto.yml`:
11+
12+
```yaml
13+
quartodoc:
14+
parser: google
15+
```
16+
17+
Currently, google, sphinx, and numpy are supported. Parsing is handled by the tool [griffe](https://github.com/mkdocstrings/griffe).
18+
19+
### Resources
20+
1121
See the [numpydoc sections guide][numpydoc] for more information and examples.
1222
1323
[numpydoc]: https://numpydoc.readthedocs.io/en/latest/format.html#sections

0 commit comments

Comments
 (0)