From b1b2131b0c4b13844a3eb5545b79b2111752c13a Mon Sep 17 00:00:00 2001 From: Sergei Trofimov Date: Fri, 18 May 2018 10:03:20 +0100 Subject: [PATCH] doc: fix build warnings --- doc/build_plugin_docs.py | 9 +++++++-- doc/source/conf.py | 2 +- doc/source/developer_reference.rst | 2 +- doc/source/developer_reference/contributing.rst | 2 +- .../{writing_extensions.rst => writing_plugins.rst} | 0 doc/source/index.rst | 1 + doc/source/run_config/Run_Configuration.rst | 11 ++++++----- wa/framework/configuration/core.py | 11 ++++++----- wa/workloads/geekbench/__init__.py | 2 ++ 9 files changed, 25 insertions(+), 15 deletions(-) rename doc/source/developer_reference/{writing_extensions.rst => writing_plugins.rst} (100%) diff --git a/doc/build_plugin_docs.py b/doc/build_plugin_docs.py index 0092ce25..fd9d7d9b 100755 --- a/doc/build_plugin_docs.py +++ b/doc/build_plugin_docs.py @@ -57,9 +57,14 @@ def generate_plugin_documentation(source_dir, outdir, ignore_paths): wfh.write(insert_contents_table()) wfh.write(line_break()) exts = pluginloader.list_plugins(ext_type) - for ext in sorted(exts, key=lambda x: x.name): - wfh.write(get_rst_from_plugin(ext)) + sorted_exts = iter(sorted(exts, key=lambda x: x.name)) + try: + wfh.write(get_rst_from_plugin(sorted_exts.next())) + except StopIteration: + return + for ext in sorted_exts: wfh.write(line_break()) + wfh.write(get_rst_from_plugin(ext)) def generate_target_documentation(outdir): diff --git a/doc/source/conf.py b/doc/source/conf.py index 33d1da81..4258e8b7 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -159,7 +159,7 @@ html_theme = 'sphinx_rtd_theme' # 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, # 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 # .htaccess) here, relative to this directory. These files are copied diff --git a/doc/source/developer_reference.rst b/doc/source/developer_reference.rst index ccd73ff4..175ab26b 100644 --- a/doc/source/developer_reference.rst +++ b/doc/source/developer_reference.rst @@ -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/revent.rst diff --git a/doc/source/developer_reference/contributing.rst b/doc/source/developer_reference/contributing.rst index 875f44b5..8e0c5bc3 100644 --- a/doc/source/developer_reference/contributing.rst +++ b/doc/source/developer_reference/contributing.rst @@ -17,7 +17,7 @@ consistent with the rest of WA code. Briefly, it is *not* use Hungarian notation (so prefer ``birth_date`` over ``dtBirth``). 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 submitting a pull request: diff --git a/doc/source/developer_reference/writing_extensions.rst b/doc/source/developer_reference/writing_plugins.rst similarity index 100% rename from doc/source/developer_reference/writing_extensions.rst rename to doc/source/developer_reference/writing_plugins.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 4fe11ccc..a070859c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,4 +1,5 @@ .. Workload Automation 3 documentation master file, + ================================================ Welcome to Documentation for Workload Automation ================================================ diff --git a/doc/source/run_config/Run_Configuration.rst b/doc/source/run_config/Run_Configuration.rst index 8136414b..3fe7d508 100644 --- a/doc/source/run_config/Run_Configuration.rst +++ b/doc/source/run_config/Run_Configuration.rst @@ -80,19 +80,20 @@ retry_on_status: This is list of statuses on which a job will be considered to have failed and will be automatically retried up to ``max_retries`` times. This defaults to ``["FAILED", "PARTIAL"]`` if not set. - Possible values are:: + Possible values are: ``"OK"`` - This iteration has completed and no errors have been detected + This iteration has completed and no errors have been detected ``"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"`` - The workload itself has failed. + The workload itself has failed. ``"ABORTED"`` - The user interrupted the workload + The user interrupted the workload. allowed values: ``RUNNING``, ``OK``, ``PARTIAL``, ``FAILED``, ``ABORTED``, ``SKIPPED`` diff --git a/wa/framework/configuration/core.py b/wa/framework/configuration/core.py index a6313e43..5fbf407f 100644 --- a/wa/framework/configuration/core.py +++ b/wa/framework/configuration/core.py @@ -628,19 +628,20 @@ class RunConfiguration(Configuration): This is list of statuses on which a job will be considered to have failed and will be automatically retried up to ``max_retries`` times. This defaults to ``["FAILED", "PARTIAL"]`` if not set. - Possible values are:: + Possible values are: ``"OK"`` - This iteration has completed and no errors have been detected + This iteration has completed and no errors have been detected ``"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"`` - The workload itself has failed. + The workload itself has failed. ``"ABORTED"`` - The user interrupted the workload + The user interrupted the workload. ''', ), ConfigurationPoint( diff --git a/wa/workloads/geekbench/__init__.py b/wa/workloads/geekbench/__init__.py index b4a42e0c..04639bc7 100644 --- a/wa/workloads/geekbench/__init__.py +++ b/wa/workloads/geekbench/__init__.py @@ -38,10 +38,12 @@ class Geekbench(ApkUiautoWorkload): the score of a single-processor Power Mac G5 @ 1.6GHz). Higher scores are better, with double the score indicating double the performance. The benchmarks fall into one of four categories: + - integer performance. - floating point performance. - memory performance. - stream performance. + Geekbench benchmarks: http://www.primatelabs.com/geekbench/doc/benchmarks.html Geekbench scoring methedology: http://support.primatelabs.com/kb/geekbench/interpreting-geekbench-scores