Quarto Manual Page

Description

Class handling the creation of the quarto markdown (.qmd) manual pages.

Usage

ManPage(name, obj, config, parent=None)

Arguments

namestr
Name of the function, class, or method.
objfunction or class
The function or class to be documented.
configConfig
Object of class Config.
parentNone, str
None (default) if a class or function is documented. Used to document methods, in this case parent contains the name of the parent class as str.

Return

Initializes an object of this class.

Methods

ManPage.config_get(what)
Get Config Argument
ManPage.fullname()
WARNING(short_description missing)
ManPage.get(attr)
WARNING(short_description missing)
ManPage.get_example_qmd()
WARNING(short_description missing)
ManPage.getmembers()
WARNING(short_description missing)
ManPage.isclass()
WARNING(short_description missing)
ManPage.isfunction()
WARNING(short_description missing)
ManPage.quartofile()
WARNING(short_description missing)
ManPage.signature(remove_self=None, max_length=200)
WARNING(short_description missing)
ManPage.write_examples_qmd()
WARNING(short_description missing)
ManPage.write_qmd()
WARNING(short_description missing)