1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-04-15 07:10:56 +01:00

doc: fix build warnings

This commit is contained in:
Sergei Trofimov 2018-05-18 10:03:20 +01:00 committed by Marc Bonnici
parent 3f7f0b38f5
commit b1b2131b0c
9 changed files with 25 additions and 15 deletions

View File

@ -57,9 +57,14 @@ def generate_plugin_documentation(source_dir, outdir, ignore_paths):
wfh.write(insert_contents_table()) wfh.write(insert_contents_table())
wfh.write(line_break()) wfh.write(line_break())
exts = pluginloader.list_plugins(ext_type) exts = pluginloader.list_plugins(ext_type)
for ext in sorted(exts, key=lambda x: x.name): sorted_exts = iter(sorted(exts, key=lambda x: x.name))
wfh.write(get_rst_from_plugin(ext)) try:
wfh.write(get_rst_from_plugin(sorted_exts.next()))
except StopIteration:
return
for ext in sorted_exts:
wfh.write(line_break()) wfh.write(line_break())
wfh.write(get_rst_from_plugin(ext))
def generate_target_documentation(outdir): def generate_target_documentation(outdir):

View File

@ -159,7 +159,7 @@ html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['static'] # html_static_path = ['static']
# Add any extra paths that contain custom files (such as robots.txt or # Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied # .htaccess) here, relative to this directory. These files are copied

View File

@ -11,7 +11,7 @@ Developer Reference
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
.. include:: developer_reference/writing_extensions.rst .. include:: developer_reference/writing_plugins.rst
.. include:: developer_reference/contributing.rst .. include:: developer_reference/contributing.rst
.. include:: developer_reference/revent.rst .. include:: developer_reference/revent.rst

View File

@ -17,7 +17,7 @@ consistent with the rest of WA code. Briefly, it is
*not* use Hungarian notation (so prefer ``birth_date`` over ``dtBirth``). *not* use Hungarian notation (so prefer ``birth_date`` over ``dtBirth``).
New extensions should also follow implementation guidelines specified in New extensions should also follow implementation guidelines specified in
:ref:`writing_extensions` section of the documentation. :ref:`writing-plugins` section of the documentation.
We ask that the following checks are performed on the modified code prior to We ask that the following checks are performed on the modified code prior to
submitting a pull request: submitting a pull request:

View File

@ -1,4 +1,5 @@
.. Workload Automation 3 documentation master file, .. Workload Automation 3 documentation master file,
================================================ ================================================
Welcome to Documentation for Workload Automation Welcome to Documentation for Workload Automation
================================================ ================================================

View File

@ -80,19 +80,20 @@ retry_on_status:
This is list of statuses on which a job will be considered to have This is list of statuses on which a job will be considered to have
failed and will be automatically retried up to ``max_retries`` failed and will be automatically retried up to ``max_retries``
times. This defaults to ``["FAILED", "PARTIAL"]`` if not set. times. This defaults to ``["FAILED", "PARTIAL"]`` if not set.
Possible values are:: Possible values are:
``"OK"`` ``"OK"``
This iteration has completed and no errors have been detected This iteration has completed and no errors have been detected
``"PARTIAL"`` ``"PARTIAL"``
One or more instruments have failed (the iteration may still be running). One or more instruments have failed (the iteration may still be
running).
``"FAILED"`` ``"FAILED"``
The workload itself has failed. The workload itself has failed.
``"ABORTED"`` ``"ABORTED"``
The user interrupted the workload The user interrupted the workload.
allowed values: ``RUNNING``, ``OK``, ``PARTIAL``, ``FAILED``, ``ABORTED``, ``SKIPPED`` allowed values: ``RUNNING``, ``OK``, ``PARTIAL``, ``FAILED``, ``ABORTED``, ``SKIPPED``

View File

@ -628,19 +628,20 @@ class RunConfiguration(Configuration):
This is list of statuses on which a job will be considered to have This is list of statuses on which a job will be considered to have
failed and will be automatically retried up to ``max_retries`` failed and will be automatically retried up to ``max_retries``
times. This defaults to ``["FAILED", "PARTIAL"]`` if not set. times. This defaults to ``["FAILED", "PARTIAL"]`` if not set.
Possible values are:: Possible values are:
``"OK"`` ``"OK"``
This iteration has completed and no errors have been detected This iteration has completed and no errors have been detected
``"PARTIAL"`` ``"PARTIAL"``
One or more instruments have failed (the iteration may still be running). One or more instruments have failed (the iteration may still be
running).
``"FAILED"`` ``"FAILED"``
The workload itself has failed. The workload itself has failed.
``"ABORTED"`` ``"ABORTED"``
The user interrupted the workload The user interrupted the workload.
''', ''',
), ),
ConfigurationPoint( ConfigurationPoint(

View File

@ -38,10 +38,12 @@ class Geekbench(ApkUiautoWorkload):
the score of a single-processor Power Mac G5 @ 1.6GHz). Higher scores are the score of a single-processor Power Mac G5 @ 1.6GHz). Higher scores are
better, with double the score indicating double the performance. better, with double the score indicating double the performance.
The benchmarks fall into one of four categories: The benchmarks fall into one of four categories:
- integer performance. - integer performance.
- floating point performance. - floating point performance.
- memory performance. - memory performance.
- stream performance. - stream performance.
Geekbench benchmarks: http://www.primatelabs.com/geekbench/doc/benchmarks.html Geekbench benchmarks: http://www.primatelabs.com/geekbench/doc/benchmarks.html
Geekbench scoring methedology: Geekbench scoring methedology:
http://support.primatelabs.com/kb/geekbench/interpreting-geekbench-scores http://support.primatelabs.com/kb/geekbench/interpreting-geekbench-scores