Config Setup

Description

action = "init" initializes the auto-generated documentation and will automatically create the quarto website template including a _quarto.yml file and pyp.sass. Will thorw an exception one of these files already exists, except if the user allows for overwrite = True (take care, the current content of _quarto.yml will be overwritten).

action = "document" parses the python package classes and functions and will update the man pages. It will, however, not overwrite _quarto.yml. When used the first time, it will also initialize the output folder structure and create the required files (_quarto.yml, pyp.sass) similar to the init action.

Usage

Config.setup(action, package,
             quarto_dir='_quarto',
             man_dir='man',
             output_dir='_site',
             overwrite=False, include_hidden=False,
             examples_dir='_examples',
             docstringstyle='GOOGLE',
             silent=False)

Arguments

• WARNING(missing argument definition “examples_dir” in docstring)

actionstr

Action to be executed. One of "init" or "document", see method description.

packagestr

Name of the package which should be documented.

quarto_dirstr

Output directory, defaults to "_quarto".

man_dirstr

Name of the directory for the manual pages (subfolder inside quarto_dir), defaults to "man".

output_dirstr

Directory for the rendered quarto website, used as output-dir target in _quarto.yml, relative to quarto_dir. Defaults to "_site".

overwritebool

Only used if action = "init", see method description.

include_hiddenbool

If False (default), classes, functions, and methods starting with an underscore will not be documented (no quarto man pages will be crated). Dunder classes, functions, and methods are always excluded.

docstringstylestr

Style of the docstrings in the package, must be one of the allowed types of the docstring_parser package (AUTO, EPYDOC, GOOGLE, NUMPYDOC, REST), defaults to "GOOGLE"; not case sensitive.

silentbool

If False (default) some output will be produced when rendering the man pages. Can be specified to silence the execution.

Raises

• TypeError: If the inputs are not of the expected type.
• ValueError: If action is not one of the allowed ones.