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.

doc/source/faq.rst

@@ -0,0 +1,58 @@
+.. _faq:
+
+FAQ
+===
+
+.. contents::
+   :depth: 1
+   :local:
+
+---------------------------------------------------------------------------------------
+
+
+**Q:** I receive the error: ``"<<Workload> file <file_name> file> could not be found."``
+-----------------------------------------------------------------------------------------
+
+**A:** Some workload e.g. AdobeReader, GooglePhotos etc require external asset
+files. We host some additional workload dependencies in the `WA Assets Repo
+<https://github.com/ARM-software/workload-automation-assets>`_. To allow WA to
+try and automatically download required assets from the repository please add
+the following to your configuration:
+
+.. code-block:: YAML
+
+        remote_assets_url: https://raw.githubusercontent.com/ARM-software/workload-automation-assets/master/dependencies
+
+------------
+
+**Q:** I receive the error: ``"No matching package found for workload <workload>"``
+------------------------------------------------------------------------------------
+
+**A:** WA cannot locate the application required for the workload. Please either
+install the application onto the device or source the apk and place into
+``$WA_USER_DIRECTORY/dependencies/<workload>``
+
+------------
+
+**Q:** I have a big.LITTLE device but am unable to set parameters corresponding to the big or little core and receive the error ``"Unknown runtime parameter"``
+--------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+**A:** Please ensure you have the hot plugging module enabled for your device.
+
+
+**A:** This can occur if the device uses dynamic hot-plugging and although WA
+will try to online all cores to perform discovery sometimes this can fail
+causing to WA to incorrectly assume that only one cluster is present. To
+workaround this please set the ``core_names`` :ref:`parameter <core-names>` in the configuration for
+your device.
+
+
+**Q:** I receive the error ``Could not find plugin or alias "standard"``
+------------------------------------------------------------------------
+
+**A:** Upon first use of WA3, your WA2 config file typically located at
+``$USER_HOME/config.py`` will have been convered to a WA3 config file located at
+``$USER_HOME/config.yaml``. The "standard" output processor, present in WA2, has
+been merged into the core framework and therefore no longer exists. To fix this
+error please remove the "standard" entry from the "augmentations" list in the
+WA3 config file.