update docs for consistency

adjust the index file to be more readable for the field guide

adjust titles to make more sense when displayed in top level index

change theme to 'nature', which is closer to the openstack default
style. Will eventually write our own style here.

Change-Id: I4f5fed65f9e26a4e4d333b1be4ed02c9ec246b9a
This commit is contained in:
Sean Dague 2013-05-24 08:49:44 -04:00
parent b56052b475
commit 7679b488ed
4 changed files with 15 additions and 7 deletions

View File

@ -91,7 +91,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'nature'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the

View File

@ -3,6 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
===================================
Tempest Testing Project
===================================
@ -14,10 +15,15 @@ Contents:
overview
Field Guide:
-------------------------------
Field Guides
-------------------------------
Tempest contains tests of many different types, the field guides
attempt to explain these in a way that makes it easy to understand
where your test contributions should go.
.. toctree::
:maxdepth: 2
:maxdepth: 1
field_guide/index
field_guide/api
@ -28,6 +34,7 @@ Field Guide:
field_guide/whitebox
==================
Indices and tables
==================

View File

@ -1,5 +1,6 @@
Tempest Field Guide
========
============
Tempest Field Guide Overview
============
Tempest is designed to be useful for a large number of different
environments. This includes being useful for gating commits to

View File

@ -1,4 +1,4 @@
Quanta Research Cambridge OpenStack Stress Test System
Tempest Field Guide to Stress Tests
======================================================
Nova is a distributed, asynchronous system that is prone to race condition
@ -10,7 +10,7 @@ in a more controlled environment.
Environment
------------
This particular framework assumes your working Nova cluster understands Nova
This particular framework assumes your working Nova cluster understands Nova
API 2.0. The stress tests can read the logs from the cluster. To enable this
you have to provide the hostname to call 'nova-manage' and
the private key and user name for ssh to the cluster in the