stackviz/doc/source/index.rst
Austin Clark f3848085e1 Restructure Stackviz docs
This patch changes the format of Stackviz docs so that all information
is stored in the appropriate doc/source/ directory rather than all
in README.rst. README.rst now just uses the RST include directive to
get its text from doc/source/readme.rst. Usage and installation are
now in their own RST files for increased modularity, and are included
in doc/source/readme.rst.

Additional developer documentation has also been created at
doc/source/man/ and includes more information on stackviz-export
as well as the AngularJS front-end.

Change-Id: I1d37194add998cf83a66d380ec7390e31184bdb3
2016-03-22 11:54:57 -06:00

699 B

Welcome to Stackviz's documentation!

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:

readme installation usage

Manual Pages:

man/*

Indices and tables

  • genindex
  • modindex
  • search