-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #301 from machow/docs-docstring-styles
docs: configuring docstring styles
- Loading branch information
Showing
1 changed file
with
12 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,23 @@ | ||
--- | ||
title: numpydoc style | ||
title: Docstring formats | ||
jupyter: | ||
kernelspec: | ||
display_name: Python 3 (ipykernel) | ||
language: python | ||
name: python3 | ||
--- | ||
|
||
quartodoc expects numpydoc style for docstrings. | ||
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`: | ||
|
||
```yaml | ||
quartodoc: | ||
parser: google | ||
``` | ||
Currently, google, sphinx, and numpy are supported. Parsing is handled by the tool [griffe](https://github.com/mkdocstrings/griffe). | ||
### Resources | ||
See the [numpydoc sections guide][numpydoc] for more information and examples. | ||
[numpydoc]: https://numpydoc.readthedocs.io/en/latest/format.html#sections |