Skip to main content

Docstring formats

quartodoc prefers numpy style for docstrings, but can support other styles by configuring parser in your quartodoc site options of _quarto.yml:

quartodoc:
  parser: google

Currently, google, sphinx, and numpy are supported. Parsing is handled by the tool griffe.

Options for griffe’s parser go in parser_options. For example, to document parameters that a function takes through **kwargs without a warning for each, and to allow parameters without types:

quartodoc:
  parser: google
  parser_options:
    warn_unknown_params: false
    warn_missing_types: false

See griffe’s docs for the options of each parser.

Resources

See the numpydoc sections guide for more information and examples.