f3848085e1
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
33 lines
699 B
ReStructuredText
33 lines
699 B
ReStructuredText
|
|
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:
|
|
---------------
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
readme
|
|
installation
|
|
usage
|
|
|
|
Manual Pages:
|
|
-------------
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
man/*
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|