Skip to main content

blueprint

blueprint(el, package=None, dynamic=None, parser='numpy', parser_options=None)

Convert a configuration element to something that is ready to render.

Parameters

el : _Base

An element, like layout.Auto, to transform.

package : str = None

A base package name. If specified, this is prepended to the names of any objects.

dynamic : None | bool = None

Whether to dynamically load objects. Defaults to using static analysis.

parser : = 'numpy'

The docstring parser to use: “google”, “sphinx”, or “numpy”.

parser_options : 'dict | None' = None

Options passed to griffe’s docstring parser, e.g. {"warn_unknown_params": False}.

Examples

>>> from quartodoc import blueprint
>>> from quartodoc.layout import Auto
>>> blueprint(Auto(name = "quartodoc.get_object"))
DocFunction(name='quartodoc.get_object', ...)
>>> blueprint(Auto(name = "get_object"), package = "quartodoc")
DocFunction(name='get_object', ...)