Builder
Builder(self, package, sections=tuple(), options=None, version=None, dir='reference', title='Function reference', renderer='markdown', out_index=None, sidebar=None, rewrite_all_pages=False, source_dir=None, dynamic=None, parser='numpy', render_interlinks=False, _fast_inventory=False)
Base class for building API docs.
Parameters
Name | Type | Description | Default |
---|---|---|---|
package |
str | The name of the package. | required |
sections |
‘list[Any]’ | A list of sections, with items to document. | tuple() |
version |
‘str | None’ | The package version. By default this attempts to look up the current package version (TODO). | None |
dir |
str | Name of API directory. | 'reference' |
title |
str | Title of the API index page. | 'Function reference' |
renderer |
‘dict | Renderer | str’ | The renderer used to convert docstrings (e.g. to markdown). | 'markdown' |
options |
‘dict | None’ | Default options to set for all pieces of content (e.g. include_attributes). | None |
out_index |
str | The output path of the index file, used to list all API functions. | None |
sidebar |
‘str | None’ | The output path for a sidebar yaml config (by default no config generated). | None |
rewrite_all_pages |
Whether to rewrite all rendered doc pages, or only those with changes. | False |
|
source_dir |
‘str | 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. | None |
dynamic |
bool | None | Whether to dynamically load all python objects. By default, objects are loaded using static analysis. | None |
render_interlinks |
bool | Whether to render interlinks syntax inside documented objects. Note that the interlinks filter is required to generate the links in quarto. | False |
parser |
Docstring parser to use. This correspond to different docstring styles, and can be one of “google”, “sphinx”, and “numpy”. Defaults to “numpy”. | 'numpy' |