# wlauto.tools package¶

## wlauto.tools.extdoc module¶

This module contains utilities for generating user documentation for Workload Automation Extensions.

class wlauto.tools.extdoc.ExtensionDocumenter(ext)[source]

Bases: object

description

The description for an extension is specified in the description attribute, or (legacy) as a docstring for the extension’s class. If neither method is used in the Extension, an empty string is returned.

Description is assumed to be formed as reStructuredText. Leading and trailing whitespace will be stripped away.

name
parameters
summary

Returns the summary description for this Extension, which, by convention, is the first paragraph of the description.

class wlauto.tools.extdoc.ExtensionParameterDocumenter(param)[source]

Bases: object

constraint
default
description
kind
name
wlauto.tools.extdoc.get_paragraphs(text)[source]

returns a list of paragraphs contained in the text