pimlico.utils.docs.modulegen module

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

pimlico.utils.docs.modulegen.generate_contents_page(modules, output_dir, index_name, title, content)[source]
pimlico.utils.docs.modulegen.generate_docs_for_pimlico_mod(module_path, output_dir)[source]
pimlico.utils.docs.modulegen.generate_docs_for_pymod(module, output_dir)[source]

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

pimlico.utils.docs.modulegen.input_datatype_list(types)[source]
pimlico.utils.docs.modulegen.input_datatype_text(datatype)[source]
pimlico.utils.docs.modulegen.output_datatype_text(datatype)[source]