handadoc_client

Module Attributes

DOCUMENTATION_NAME_PATTERN	The allowed name pattern of documentations to be uploaded onto handadoc.
SPHINX_SETUP_FILENAME	Configuration file of sphinx.
PROJECT_SETUP_FILENAME	Filename of the handadoc-client setup for an automated documentation deployment.

Functions

get_docu_sub_path(project_setup)
get_target_path_of_documentation(…)	Makes the root folder path of the documentation.
is_static_html_file(filepath)
unzip_documentation(destination_path, …)	Extracts the documentation.
validate_docu_setup(setup_to_validate)

Classes

DocuSetup(name, description, doc_location, …)
ProcessMessage(success, message)