gocs: Move html result documentation to optional_plugins

We have a new section "optional_plugins". Let's create a "results"
category, move the "html" plugin documentation there and link to this
place from the "Result formats" section.
Signed-off-by: NLukáš Doktor <ldoktor@redhat.com>

docs/source/ResultFormats.rst

@@ -6,6 +6,9 @@ Result Formats
 A test runner must provide an assortment of ways to clearly communicate results
 to interested parties, be them humans or machines.
 
+.. note:: There are several optional result plugins, you can find them in
+   :ref:`result-plugins`.
+
 Results for human beings
 ------------------------
 
@@ -34,32 +37,6 @@ that is, the job and its test(s) results are constantly updated::
 The most important thing is to remember that programs should never need to parse
 human output to figure out what happened to a test job run.
 
-HTML report
-~~~~~~~~~~~
-
-As can be seen in the previous example, Avocado shows the path to an HTML
-report that will be generated as soon as the job finishes running::
-
-    $ avocado run sleeptest.py failtest.py synctest.py
-    ...
-    JOB HTML  : $HOME/avocado/job-results/job-2014-08-12T15.57-5ffe4792/html/results.html
-    ...
-
-You can also request that the report be opened automatically by using the
-``--open-browser`` option. For example::
-
-    $ avocado run sleeptest --open-browser
-
-Will show you the nice looking HTML results report right after ``sleeptest``
-finishes running.
-
-.. warning:: The HTML output is an optional plugin and has to be installed
-             separately as ``avocado-plugins-output-html`` RPM or by executing
-             ``cd optional_plugins/html && python setup.py install``
-             from avocado sources. Note it's enabled by default when using
-             avocado from sorces by ``make develop`` or ``make link``.
-
-
 Machine readable results
 ------------------------
 

docs/source/index.rst

@@ -28,7 +28,7 @@ Optional Plugins
 ================
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
    optional_plugins/index
 

docs/source/optional_plugins/index.rst

@@ -9,4 +9,4 @@ The following pages are the documentation for the optical plugins:
 .. toctree::
    :maxdepth: 1
 
-   resultsdb
+   results.rst

docs/source/optional_plugins/resultsdb.rst → docs/source/optional_plugins/results.rst

-================
+.. _result-plugins:
+
+==============
+Result plugins
+==============
+
+Optional plugins providing various types of job results.
+
+
+HTML results Plugin
+===================
+
+This optional plugin creates beautiful human readable results.
+
+To install the HTML plugin from pip, use::
+
+    pip install avocado-framework-plugin-result-html
+
+Once installed it produces the results in job results dir::
+
+    $ avocado run sleeptest.py failtest.py synctest.py
+    ...
+    JOB HTML  : /home/medic/avocado/job-results/job-2014-08-12T15.57-5ffe4792/html/results.html
+    ...
+
+
+This can be disabled via --html-job-result on|off. One can also
+specify a custom location via --html . Last but not least
+--open-browser can be used to start browser automatically once
+the job finishes.
+
+
 ResultsDB Plugin
 ================
 
@@ -17,7 +48,7 @@ Optionally, you can provide the URL where the Avocado logs are published::
 
     avocado run passtest.py --resultsdb-api http://resultsdb.example.com/api/v2.0/ --resultsdb-logs http://avocadologs.example.com/
 
-The ``--resultsdb-logs`` is a convenience option that will create links
+The --resultsdb-logs is a convenience option that will create links
 to the logs in the ResultsDB records. The links will then have the
 following formats:
 
@@ -35,6 +66,6 @@ You can also set the ResultsDB API URL and logs URL using a config file::
     api_url = http://resultsdb.example.com/api/v2.0/
     logs_url = http://avocadologs.example.com/
 
-And then run the Avocado command without the ``--resultsdb-api`` and
-``--resultsdb-logs`` options. Notice that the command line options will
+And then run the Avocado command without the --resultsdb-api and
+--resultsdb-logs options. Notice that the command line options will
 have precedence over the configuration file.