docs

Documentation-related functionality

Authors:

• Stijn De Weirdt (Ghent University)
• Dries Verdegem (Ghent University)
• Kenneth Hoste (Ghent University)
• Pieter De Baets (Ghent University)
• Jens Timmerman (Ghent University)
• Toon Willems (Ghent University)
• Ward Poelmans (Ghent University)
• Caroline De Brouwer (Ghent University)

avail_cfgfile_constants(go_cfg_constants, output_format=FORMAT_TXT)

Return overview of constants supported in configuration files.

avail_cfgfile_constants_json(go_cfg_constants)

Generate documentation on constants for configuration files in json format

avail_cfgfile_constants_md(go_cfg_constants)

Generate documentation on constants for configuration files in MarkDown format

avail_cfgfile_constants_rst(go_cfg_constants)

Generate documentation on constants for configuration files in rst format

avail_cfgfile_constants_txt(go_cfg_constants)

Generate documentation on constants for configuration files in txt format

avail_classes_tree(classes, class_names, locations, detailed, format_strings, depth=0)

Print list of classes as a tree.

avail_easyconfig_constants(output_format=FORMAT_TXT)

Generate the easyconfig constant documentation

avail_easyconfig_constants_json()

Generate easyconfig constant documentation in json format

avail_easyconfig_constants_md()

Generate easyconfig constant documentation in MarkDown format

avail_easyconfig_constants_rst()

Generate easyconfig constant documentation in rst format

avail_easyconfig_constants_txt()

Generate easyconfig constant documentation in txt format

avail_easyconfig_licenses(output_format=FORMAT_TXT)

Generate the easyconfig licenses documentation

avail_easyconfig_licenses_json()

Generate easyconfig license documentation in json format

avail_easyconfig_licenses_md()

Generate easyconfig license documentation in MarkDown format

avail_easyconfig_licenses_rst()

Generate easyconfig license documentation in rst format

avail_easyconfig_licenses_txt()

Generate easyconfig license documentation in txt format

avail_easyconfig_params(easyblock, output_format=FORMAT_TXT)

Compose overview of available easyconfig parameters, in specified format.

avail_easyconfig_params_json()

Compose overview of available easyconfig parameters, in json format.

avail_easyconfig_params_md(title, grouped_params)

Compose overview of available easyconfig parameters, in MarkDown format.

avail_easyconfig_params_rst(title, grouped_params)

Compose overview of available easyconfig parameters, in RST format.

avail_easyconfig_params_txt(title, grouped_params)

Compose overview of available easyconfig parameters, in plain text format.

avail_easyconfig_templates(output_format=FORMAT_TXT)

Generate the templating documentation

avail_easyconfig_templates_json()

Returns template documentation in json text format

avail_easyconfig_templates_md()

Returns template documentation in MarkDown format.

avail_easyconfig_templates_rst()

Returns template documentation in rst format

avail_easyconfig_templates_txt()

Returns template documentation in plain text format

avail_toolchain_opts(name, output_format=FORMAT_TXT)

Show list of known options for given toolchain.

avail_toolchain_opts_json(name, tc_dict)

Returns overview of toolchain options in jsonformat

avail_toolchain_opts_md(name, tc_dict)

Returns overview of toolchain options in MarkDown format

avail_toolchain_opts_rst(name, tc_dict)

Returns overview of toolchain options in rst format

avail_toolchain_opts_txt(name, tc_dict)

Returns overview of toolchain options in txt format

gen_easyblock_doc_section_md(eb_class, path_to_examples, common_params, doc_functions, all_eb_classes)

Compose overview of one easyblock given class object of the easyblock in MarkDown format

gen_easyblock_doc_section_rst(eb_class, path_to_examples, common_params, doc_functions, all_blocks)

Compose overview of one easyblock given class object of the easyblock in rst format

gen_easyblocks_overview_json(package_name, path_to_examples, common_params=None, doc_functions=None)

Compose overview of all easyblocks in the given package in json format

gen_easyblocks_overview_md(package_name, path_to_examples, common_params=None, doc_functions=None)

Compose overview of all easyblocks in the given package in MarkDown format

gen_easyblocks_overview_rst(package_name, path_to_examples, common_params=None, doc_functions=None)

Compose overview of all easyblocks in the given package in rst format

gen_list_easyblocks(list_easyblocks, format_strings)

Get a class tree for easyblocks.

generate_doc(name, params)

Generate documentation by calling function with specified name, using supplied parameters.

get_easyblock_classes(package_name)

Get list of all easyblock classes in specified easyblocks.* package

list_software(output_format=FORMAT_TXT, detailed=False, only_installed=False)

Show list of supported software

PARAMETER	DESCRIPTION
output_format	output format to use DEFAULT: FORMAT_TXT
detailed	whether or not to return detailed information (incl. version, versionsuffix, toolchain info) DEFAULT: False
only_installed	only retain software for which a corresponding module is available DEFAULT: False

RETURNS	DESCRIPTION
	multi-line string presenting requested info

list_software_json(software, detailed=False)

Return overview of supported software in json

PARAMETER	DESCRIPTION
software	software information (strucuted like list_software does)
detailed	whether or not to return detailed information (incl. version, versionsuffix, toolchain info) DEFAULT: False

RETURNS	DESCRIPTION
	multi-line string presenting requested info

list_software_md(software, detailed=True)

Return overview of supported software in MarkDown format

PARAMETER	DESCRIPTION
software	software information (structured like list_software does)
detailed	whether or not to return detailed information (incl. version, versionsuffix, toolchain info) DEFAULT: True

RETURNS	DESCRIPTION
	multi-line string presenting requested info

list_software_rst(software, detailed=False)

Return overview of supported software in RST format

PARAMETER	DESCRIPTION
software	software information (structured like list_software does)
detailed	whether or not to return detailed information (incl. version, versionsuffix, toolchain info) DEFAULT: False

RETURNS	DESCRIPTION
	multi-line string presenting requested info

list_software_txt(software, detailed=False)

Return overview of supported software in plain text

PARAMETER	DESCRIPTION
software	software information (structured like list_software does)
detailed	whether or not to return detailed information (incl. version, versionsuffix, toolchain info) DEFAULT: False

RETURNS	DESCRIPTION
	multi-line string presenting requested info

list_toolchains(output_format=FORMAT_TXT)

Show list of known toolchains.

list_toolchains_json(tcs)

Returns overview of all toolchains in json format

list_toolchains_md(tcs)

Returns overview of all toolchains in MarkDown format

list_toolchains_rst(tcs)

Returns overview of all toolchains in rst format

list_toolchains_txt(tcs)

Returns overview of all toolchains in txt format

md_title_and_table(title, table_titles, table_values, title_level=1)

Generate table in section with title in MarkDown (.md) format.

rst_title_and_table(title, table_titles, table_values)

Generate table in section with title in .rst format.