mirror of
https://github.com/ARM-software/workload-automation.git
synced 2025-10-30 06:34:13 +00:00
Documentation: Update WA3 Documentation
Update the documentation and build system for producing documentation for WA3 with support for automatic building on readthedocs. Note: This is currently a WIP.
This commit is contained in:
54
doc/source/run_config/Meta_Configuration.rst
Normal file
54
doc/source/run_config/Meta_Configuration.rst
Normal file
@@ -0,0 +1,54 @@
|
||||
user_directory:
|
||||
type: ``'str'``
|
||||
|
||||
Path to the user directory. This is the location WA will look for
|
||||
user configuration, additional plugins and plugin dependencies.
|
||||
|
||||
default: ``'~/.workload_automation'``
|
||||
|
||||
assets_repository:
|
||||
type: ``'str'``
|
||||
|
||||
The local mount point for the filer hosting WA assets.
|
||||
|
||||
logging:
|
||||
type: ``'LoggingConfig'``
|
||||
|
||||
WA logging configuration. This should be a dict with a subset
|
||||
of the following keys::
|
||||
|
||||
:normal_format: Logging format used for console output
|
||||
:verbose_format: Logging format used for verbose console output
|
||||
:file_format: Logging format used for run.log
|
||||
:color: If ``True`` (the default), console logging output will
|
||||
contain bash color escape codes. Set this to ``False`` if
|
||||
console output will be piped somewhere that does not know
|
||||
how to handle those.
|
||||
|
||||
default: ::
|
||||
|
||||
{
|
||||
color: True,
|
||||
verbose_format: %(asctime)s %(levelname)-8s %(name)s: %(message)s,
|
||||
regular_format: %(levelname)-8s %(message)s,
|
||||
file_format: %(asctime)s %(levelname)-8s %(name)s: %(message)s
|
||||
}
|
||||
|
||||
verbosity:
|
||||
type: ``'integer'``
|
||||
|
||||
Verbosity of console output.
|
||||
|
||||
default_output_directory:
|
||||
type: ``'str'``
|
||||
|
||||
The default output directory that will be created if not
|
||||
specified when invoking a run.
|
||||
|
||||
default: ``'wa_output'``
|
||||
|
||||
extra_plugin_paths:
|
||||
type: ``'list_of_strs'``
|
||||
|
||||
A list of additional paths to scan for plugins.
|
||||
|
||||
Reference in New Issue
Block a user