multipackage.data.scripts.generate_api module

Generate API docs for all subpackages.

Summary

Exceptions:

Error

Exception that indicates an error message.

Functions:

build_parser	Build an argument parser.
delete_with_retry	Try multiple times to delete a folder.
generate_api	Generate api files for a given input folder.
main	Main entry point for generate_api.py.
verify_output	Verify that output path exists and is a directory.
verify_packages	Verify that we have all required packages.

Data:

VERSION

str(object=’‘) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Reference

exception multipackage.data.scripts.generate_api.Error(message, code=1)

Bases: Exception

Exception that indicates an error message.

multipackage.data.scripts.generate_api.delete_with_retry(folder)

Try multiple times to delete a folder.

This is required on windows because of things like: https://bugs.python.org/issue15496 https://blogs.msdn.microsoft.com/oldnewthing/20120907-00/?p=6663/ https://mail.python.org/pipermail/python-dev/2013-September/128350.html

multipackage.data.scripts.generate_api.build_parser()

Build an argument parser.

multipackage.data.scripts.generate_api.verify_output(path)

Verify that output path exists and is a directory.

Parameters:path (str) – The destination path.

multipackage.data.scripts.generate_api.verify_packages()

Verify that we have all required packages.

multipackage.data.scripts.generate_api.generate_api(input_path, template_dir, output_path, remove)

Generate api files for a given input folder.

multipackage.data.scripts.generate_api.main(argv=None)

Main entry point for generate_api.py.