modulegen

Tool to generate Pimlico module docs. Based on Sphinx’s apidoc tool.

It is assumed that this script will be run using Python 3. Although it has a basic Python 2 compatibility, it’s not really intended for Python 2 use. Modules that are marked as still awaiting update to the new datatypes system will now not be imported at all, since they are typically not Python 3 compatible (due to their use of old_datatypes, which has not been updated to Python 3).

generate_docs_for_pymod(module, output_dir, test_refs={}, example_refs={})

Generate RST docs for Pimlico modules on a given Python path and output to a directory.

generate_docs_for_pimlico_mod(module_path, output_dir, submodules=[], test_refs={}, example_refs={})

input_datatype_list(types, context=None, no_warn=False)

input_datatype_text(datatype, context=None, no_warn=False)

output_datatype_text(datatype, context=None, no_warn=False)

datatype_to_link(datatype_inst)

generate_contents_page(modules, output_dir, index_name, title, content)

generate_example_config(info, input_types, module_path, minimal=False)

Generate a string containing an example of how to configure the given module in a pipeline config file. Where possible, uses default values for options, or values appropriate to the type, and dummy input names.

indent(spaces, text)