Builder

Builder(
    package,
    sections=tuple(),
    options=None,
    version=None,
    dir='reference',
    title='Function reference',
    renderer='markdown',
    out_index=None,
    sidebar=None,
    css=None,
    rewrite_all_pages=False,
    source_dir=None,
    dynamic=None,
    parser='numpy',
    render_interlinks=False,
    index_topmatter=None,
    _fast_inventory=False,
)

Base class for building API docs.

Parameters

package : str: The name of the package.
sections : 'list[Any]' = tuple(): A list of sections, with items to document.
version : 'str | None' = None: The package version. By default this attempts to look up the current package version (TODO).
dir : str = 'reference': Name of API directory.
title : str = 'Function reference': Title of the API index page. This is sets the title in the yaml topmatter. Set title to None to not produce any topmatter at all.
renderer : 'dict | Renderer | str' = 'markdown': The renderer used to convert docstrings (e.g. to markdown).
options : 'dict | None' = None: Default options to set for all pieces of content (e.g. include_attributes).
out_index : str = None: The output path of the index file, used to list all API functions.
sidebar : 'str | dict[str, Any] | None' = None: The output path for a sidebar yaml config (by default no config generated). Alternatively, can be a dictionary of Quarto sidebar options with an additional file key containing the output path for the sidebar YAML config file (by default _quartodoc-sidebar.yml if not specified).
css : 'str | None' = None: The output path for the default css styles.
rewrite_all_pages : = False: Whether to rewrite all rendered doc pages, or only those with changes.
source_dir : 'str | None' = None: A directory where source files to be documented live. This is only necessary if you are not documenting a package, but collection of scripts. Use a “.” to refer to the current directory.
dynamic : bool | None = None: Whether to dynamically load all python objects. By default, objects are loaded using static analysis.
render_interlinks : bool = False: Whether to render interlinks syntax inside documented objects. Note that the interlinks filter is required to generate the links in quarto.
parser : = 'numpy': Docstring parser to use. This correspond to different docstring styles, and can be one of “google”, “sphinx”, and “numpy”. Defaults to “numpy”.
index_topmatter : dict = None: Custom YAML frontmatter for the API index page. When provided, this completely overrides the title configuration. Set to an empty dict to generate an empty frontmatter block. Default is None, which falls back to using the title parameter.