Restructure oslotest docs

The bulk of the documentation was coming from README.rst, probably
too much, so I moved it to it's own file under docs.

Change-Id: Iec30feae9c152af7d8b6a1b79670b3f0149d2360
This commit is contained in:
Steve Martinelli 2014-08-25 16:31:34 -04:00
parent b371ea2373
commit 04689e482e
4 changed files with 38 additions and 30 deletions

View File

@ -2,33 +2,9 @@
oslotest
==========
OpenStack test framework and test fixtures
OpenStack test framework and test fixtures.
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/oslotest
Cross-testing With Other Projects
=================================
The oslotest package can be cross-tested against its consuming
projects to ensure that no changes to the library break the tests in
those other projects.
In the Gate
-----------
Refer to the instructions in
https://wiki.openstack.org/wiki/Oslo/UsingALibrary for setting up
cross-test jobs in the gate.
Locally
-------
To run the cross-tests locally, invoke the script directly, passing
the path to the other source repository and the tox environment name
to use:
::
$ cd oslo.test
$ ./tools/run_cross_tests.sh ~/repos/openstack/oslo.config py27
* Source: http://git.openstack.org/cgit/openstack/oslotest
* Bugs: http://bugs.launchpad.net/oslo

View File

@ -7,14 +7,17 @@
Welcome to oslotest's documentation!
======================================
Contents:
OpenStack test framework and test fixtures.
Contents
========
.. toctree::
:maxdepth: 2
readme
installation
api
testing
contributing
Indices and tables

View File

@ -1 +0,0 @@
.. include:: ../../README.rst

30
doc/source/testing.rst Normal file
View File

@ -0,0 +1,30 @@
=========
Testing
=========
Cross-testing With Other Projects
=================================
The oslotest package can be cross-tested against its consuming
projects to ensure that no changes to the library break the tests in
those other projects.
In the Gate
-----------
Refer to the instructions in
https://wiki.openstack.org/wiki/Oslo/UsingALibrary for setting up
cross-test jobs in the gate.
Locally
-------
To run the cross-tests locally, invoke the script directly, passing
the path to the other source repository and the tox environment name
to use:
::
$ cd oslo.test
$ ./tools/run_cross_tests.sh ~/repos/openstack/oslo.config py27