stackviz/doc/source/index.rst

44 lines
919 B
ReStructuredText

========================================================
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
--------------
.. toctree::
:maxdepth: 2
readme
installation
usage
For Contributor
---------------
If you are a new contributor to Stackviz please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing
Manual Pages
------------
.. toctree::
:maxdepth: 1
:glob:
man/*
Indices and tables
------------------
* :ref:`search`