Fix docs and update its theme

This commit fixes the stackviz docs to show some manual pages and some
tiny sectioning. And this commit also updates to use the new theme.
There are still remaining weird indentations and some other tiny
formatting bugs. However, we can fix them in following patches.

Change-Id: I1ab055efb9bc5653f98be165cd2be3ac9cc5cd27

doc/source/conf.py

@@ -23,9 +23,14 @@ sys.path.insert(0, os.path.abspath('../..'))
 extensions = [
     'sphinx.ext.autodoc',
     #'sphinx.ext.intersphinx',
-    'oslosphinx'
+    'openstackdocstheme'
 ]
 
+# openstackdocstheme options
+repository_name = 'openstack/stackviz'
+bug_project = 'stackviz'
+bug_tag = ''
+
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
 # execute "export SPHINX_DEBUG=1" in your terminal to disable
@@ -54,8 +59,7 @@ pygments_style = 'sphinx'
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
-# html_theme_path = ["."]
-# html_theme = '_theme'
+html_theme = 'openstackdocs'
 # html_static_path = ['static']
 
 # Output file base name for HTML help builder.

doc/source/index.rst

@@ -1,32 +1,35 @@
-
+========================================================
 Welcome to Stackviz's documentation!
 ========================================================
 
+Overview
+--------
+
 Stackviz is a visualization utility to help analyze the performance of DevStack
 setup and Tempest test runs. The following documentation details the procedures
 for installing Stackviz on your local machine to view local runs, as well as
 how to use Stackviz to view upstream runs. For more information on how
 Stackviz runs, see the manual pages.
 
-Local Stackviz:
----------------
+Local Stackviz
+--------------
 .. toctree::
    :maxdepth: 2
 
    readme
    installation
    usage
+   contributing
 
-Manual Pages:
--------------
+Manual Pages
+------------
 .. toctree::
    :maxdepth: 1
+   :glob:
 
    man/*
 
 Indices and tables
-==================
+------------------
 
-* :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`

doc/source/man/stackviz-export.rst

@@ -76,6 +76,7 @@ source the
         - :code:`details`: empty, this info is available in the details JSON
         - :code:`duration`: how long the test took, in seconds
         - :code:`timestamps`: timestamps at test begin and test end
+
     This file is used in the timeline and test details page.
 
 **tempest_<source>_<id>_tree.json**

doc/source/man/stackviz-front.rst

@@ -128,13 +128,14 @@ Services
     :code:`stackviz-export` ends up in the `./app/data/` directory to be called
     by dataset service with :code:`$http` and :code:`$q` directives. Below is
     the list of calls:
-        - :code:`list` returns `config.json` using GET.
-        - :code:`get(id)` calls :code:`list`, then iterates through all the
-          available datasets for the requested id number. Rejects if not found.
-        - :code:`raw(dataset)` returns `<dataset>_raw.json` file using GET.
-        - :code:`details(dataset)` returns `<dataset>_details.json` file using GET.
-        - :code:`tree(dataset)` returns `<dataset>_tree.json` file using GET.
-        - :code:`dstat(dataset)` returns `dstat_log.csv` file using GET, if available.
+
+      - :code:`list` returns `config.json` using GET.
+      - :code:`get(id)` calls :code:`list`, then iterates through all the
+        available datasets for the requested id number. Rejects if not found.
+      - :code:`raw(dataset)` returns `<dataset>_raw.json` file using GET.
+      - :code:`details(dataset)` returns `<dataset>_details.json` file using GET.
+      - :code:`tree(dataset)` returns `<dataset>_tree.json` file using GET.
+      - :code:`dstat(dataset)` returns `dstat_log.csv` file using GET, if available.
 
 **progress**
     A wrapper for :code:`nprogress`, a progress bar library. Used in the timeline

test-requirements.txt

@@ -7,6 +7,6 @@ hacking<0.11,>=0.10.0
 coverage>=3.6
 docutils>=0.11,!=0.13.1  # OSI-Approved Open Source, Public Domain
 discover
-sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
-oslosphinx>=2.2.0  # Apache-2.0
+sphinx>=1.6.2 # BSD
 oslotest>=1.2.0  # Apache-2.0
+openstackdocstheme>=1.17.0 # Apache-2.0