easybuild.tools.docs module¶
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)
-
easybuild.tools.docs.avail_cfgfile_constants(go_cfg_constants, output_format='txt')¶ Return overview of constants supported in configuration files.
-
easybuild.tools.docs.avail_cfgfile_constants_md(go_cfg_constants)¶ Generate documentation on constants for configuration files in MarkDown format
-
easybuild.tools.docs.avail_cfgfile_constants_rst(go_cfg_constants)¶ Generate documentation on constants for configuration files in rst format
-
easybuild.tools.docs.avail_cfgfile_constants_txt(go_cfg_constants)¶ Generate documentation on constants for configuration files in txt format
-
easybuild.tools.docs.avail_classes_tree(classes, class_names, locations, detailed, format_strings, depth=0)¶ Print list of classes as a tree.
-
easybuild.tools.docs.avail_easyconfig_constants(output_format='txt')¶ Generate the easyconfig constant documentation
-
easybuild.tools.docs.avail_easyconfig_constants_md()¶ Generate easyconfig constant documentation in MarkDown format
-
easybuild.tools.docs.avail_easyconfig_constants_rst()¶ Generate easyconfig constant documentation in rst format
-
easybuild.tools.docs.avail_easyconfig_constants_txt()¶ Generate easyconfig constant documentation in txt format
-
easybuild.tools.docs.avail_easyconfig_licenses(output_format='txt')¶ Generate the easyconfig licenses documentation
-
easybuild.tools.docs.avail_easyconfig_licenses_md()¶ Generate easyconfig license documentation in MarkDown format
-
easybuild.tools.docs.avail_easyconfig_licenses_rst()¶ Generate easyconfig license documentation in rst format
-
easybuild.tools.docs.avail_easyconfig_licenses_txt()¶ Generate easyconfig license documentation in txt format
-
easybuild.tools.docs.avail_easyconfig_params(easyblock, output_format='txt')¶ Compose overview of available easyconfig parameters, in specified format.
-
easybuild.tools.docs.avail_easyconfig_params_md(title, grouped_params)¶ Compose overview of available easyconfig parameters, in MarkDown format.
-
easybuild.tools.docs.avail_easyconfig_params_rst(title, grouped_params)¶ Compose overview of available easyconfig parameters, in RST format.
-
easybuild.tools.docs.avail_easyconfig_params_txt(title, grouped_params)¶ Compose overview of available easyconfig parameters, in plain text format.
-
easybuild.tools.docs.avail_easyconfig_templates(output_format='txt')¶ Generate the templating documentation
-
easybuild.tools.docs.avail_easyconfig_templates_md()¶ Returns template documentation in MarkDown format.
-
easybuild.tools.docs.avail_easyconfig_templates_rst()¶ Returns template documentation in rst format
-
easybuild.tools.docs.avail_easyconfig_templates_txt()¶ Returns template documentation in plain text format
-
easybuild.tools.docs.avail_toolchain_opts(name, output_format='txt')¶ Show list of known options for given toolchain.
-
easybuild.tools.docs.avail_toolchain_opts_md(name, tc_dict)¶ Returns overview of toolchain options in MarkDown format
-
easybuild.tools.docs.avail_toolchain_opts_rst(name, tc_dict)¶ Returns overview of toolchain options in rst format
-
easybuild.tools.docs.avail_toolchain_opts_txt(name, tc_dict)¶ Returns overview of toolchain options in txt format
-
easybuild.tools.docs.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
-
easybuild.tools.docs.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
-
easybuild.tools.docs.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
-
easybuild.tools.docs.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
-
easybuild.tools.docs.gen_list_easyblocks(list_easyblocks, format_strings)¶ Get a class tree for easyblocks.
-
easybuild.tools.docs.generate_doc(name, params)¶ Generate documentation by calling function with specified name, using supplied parameters.
-
easybuild.tools.docs.get_easyblock_classes(package_name)¶ Get list of all easyblock classes in specified easyblocks.* package
-
easybuild.tools.docs.list_easyblocks(list_easyblocks='simple', output_format='txt')¶
-
easybuild.tools.docs.list_software(output_format='txt', detailed=False, only_installed=False)¶ Show list of supported software
Parameters: - output_format – output format to use
- detailed – whether or not to return detailed information (incl. version, versionsuffix, toolchain info)
- only_installed – only retain software for which a corresponding module is available
Returns: multi-line string presenting requested info
-
easybuild.tools.docs.list_software_md(software, detailed=True)¶ Return overview of supported software in MarkDown format
Parameters: - software – software information (structured like list_software does)
- detailed – whether or not to return detailed information (incl. version, versionsuffix, toolchain info)
Returns: multi-line string presenting requested info
-
easybuild.tools.docs.list_software_rst(software, detailed=False)¶ Return overview of supported software in RST format
Parameters: - software – software information (structured like list_software does)
- detailed – whether or not to return detailed information (incl. version, versionsuffix, toolchain info)
Returns: multi-line string presenting requested info
-
easybuild.tools.docs.list_software_txt(software, detailed=False)¶ Return overview of supported software in plain text
Parameters: - software – software information (structured like list_software does)
- detailed – whether or not to return detailed information (incl. version, versionsuffix, toolchain info)
Returns: multi-line string presenting requested info
-
easybuild.tools.docs.list_toolchains(output_format='txt')¶ Show list of known toolchains.
-
easybuild.tools.docs.list_toolchains_md(tcs)¶ Returns overview of all toolchains in MarkDown format
-
easybuild.tools.docs.list_toolchains_rst(tcs)¶ Returns overview of all toolchains in rst format
-
easybuild.tools.docs.list_toolchains_txt(tcs)¶ Returns overview of all toolchains in txt format
-
easybuild.tools.docs.md_title_and_table(title, table_titles, table_values, title_level=1)¶ Generate table in section with title in MarkDown (.md) format.
-
easybuild.tools.docs.rst_title_and_table(title, table_titles, table_values)¶ Generate table in section with title in .rst format.
