try:
futures[0].result()
print('Created output file: {file}'.format(file=output_html))
return 0
except Exception as e:
print("Failed to create file '{file}': {msg}".format(file=output_html, msg=str(e)))
return 1
OUTPUT_HTML = ConfigOptionId('output.html', 'The output HTML file. Default <input name>.html.')
HTML_CSS_STYLESHEET = ConfigOptionId(
'css.stylesheet',
'The CSS stylesheet',
default=data_file('styles/zenterio-html-theme.css'),
option_type=Path(exists=True))
HTML_COMMAND = CommandId(
'html', 'Generate HTML', html, [
ConfigOption(OUTPUT_HTML, required=False),
ConfigOption(HTML_CSS_STYLESHEET, required=True),
])
@FrameworkExtension(
name='htmlcommand',
commands=[HTML_COMMAND],
)
class HtmlCommand(AbstractExtension):
pass
default=True,
namespace='docgen',
short_alias=True)
INCLUDE_HIDDEN_OPTIONS = ConfigOptionId(
'include.hidden.options',
'Include hidden options in the generated documentation.',
option_type=Flag(),
default=True,
namespace='docgen',
short_alias=True)
INCLUDE_CUSTOM_LOGGING_DOCS = ConfigOptionId(
'include.custom.logging.docs',
'Include application-specific logging documentation items',
option_type=Path(),
multiple=True,
namespace='docgen',
short_alias=True)
DOCGEN_COMMAND = CommandId(
'docgen',
docgen.__doc__,
docgen,
config_options=[
ConfigOption(DOC_DIR, required=True),
ConfigOption(LIMIT_EXTENSION_NAMESPACES, required=False),
ConfigOption(ADDITIONAL_EXTENSIONS, required=False),
ConfigOption(INCLUDE_COMPONENTS, required=True),
ConfigOption(INCLUDE_ENDPOINTS_AND_MESSAGES, required=True),
ConfigOption(INCLUDE_CLASSES, required=True),
from zaf.config.options import ConfigOptionId
from zaf.config.types import Flag, Path
COVERAGE_ENABLED = ConfigOptionId('coverage.enabled',
'Enables coverage measurement',
option_type=Flag(),
default=False)
COVERAGE_CONFIG_FILE = ConfigOptionId(
'coverage.config.file',
'Specifies a config file that will be forwarded to coverage',
option_type=Path(exists=True))
LOG_DIR_TESTS = ConfigOptionId(
'log.dir.tests',
'Specifies directory of test specific log files',
default='${log.dir}/tests',
option_type=Path(exists=False))
'ansible.configs',
'KEY=value pairs of ansible config. The key should be the Ansible environment variable name of the config option.',
option_type=str,
multiple=True,
)
ANSIBLE_CONFIG_FILE = ConfigOptionId(
'ansible.configfile',
'Path to ansible.cfg',
option_type=str,
)
ANSIBLE_LOG_DIR = ConfigOptionId(
'ansible.log.dir',
'Relative path to log directory of the ansible log',
option_type=Path(exists=False),
default='${log.dir}/ansible',
)
ANSIBLE_PLAYBOOK = ConfigOptionId(
'ansible.playbook',
'Relative path to Ansible playbook file',
option_type=str,
)
ANSIBLE_REMOTE_USER = ConfigOptionId(
'ansible.remoteuser',
'Ansible remote user',
option_type=str,
)
from zaf.config.options import ConfigOptionId
from zaf.config.types import Choice, Path
STR_OPTION = ConfigOptionId('str.option', 'description str.option', str)
INT_OPTION = ConfigOptionId('int.option', 'description int.option', int)
FLOAT_OPTION = ConfigOptionId('float.option', 'description float.option',
float)
CHOICE_OPTION = ConfigOptionId('choice.option', 'description choice.option',
Choice(['a', 'b', 'c']))
PATH_OPTION = ConfigOptionId('path.option', 'description path.option',
Path(exists=True))
BOOL_OPTION = ConfigOptionId('bool.option', 'description bool.option', bool)