workload-automation/doc/source/index.rst

.. Workload Automation 3 documentation master file,
================================================
Welcome to Documentation for Workload Automation
================================================

Workload Automation (WA) is a framework for running workloads on real hardware devices. WA
supports a number of output formats as well as additional instruments (such as Streamline
traces). A number of workloads are included with the framework.


.. contents:: Contents


What's New
==========

.. toctree::
   :maxdepth: 1

   changes
   migration_guide

User Information
================

This section lists general usage documentation. If you're new to WA3, it is
recommended you start with the :doc:`user_guide` page. This section also contains
installation and configuration guides.

.. toctree::
   :maxdepth: 2

   installation
   user_guide
   user_reference


How To Guides
===============

.. toctree::
   :maxdepth: 3

   how_to

FAQ
====

.. toctree::
   :maxdepth: 2

   faq

.. User Reference
.. ===============

.. .. toctree::
..    :maxdepth: 2



.. _in-depth:

Developer Information
=====================

This section contains more advanced topics, such how to write your own Plugins
and detailed descriptions of how WA functions under the hood.

.. toctree::
   :maxdepth: 2

   developer_reference


References
==========

.. toctree::
   :maxdepth: 2

   plugins
   api_reference

.. :ref:`FAQ <faq>`
.. ================

.. Indices and tables
.. ==================

.. .. * :ref:`genindex`
.. .. * :ref:`modindex`
.. * :ref:`search`