Skip to content

Commit

Permalink
Merge pull request #301 from machow/docs-docstring-styles
Browse files Browse the repository at this point in the history
docs: configuring docstring styles
  • Loading branch information
machow authored Oct 20, 2023
2 parents 0205d17 + c1c6abd commit e7ffb08
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/get-started/docstring-style.qmd
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

0 comments on commit e7ffb08

Please sign in to comment.