From faf855314ac74395180fa3354440e15192088a84 Mon Sep 17 00:00:00 2001
From: Doug Hellmann <doug.hellmann@dreamhost.com>
Date: Tue, 11 Mar 2014 15:53:31 -0400
Subject: [PATCH] Fix up documentation files
Fix documentation files so sphinx does not complain about
missing headers or invalid include directives.
Change-Id: Ife520469f62ea048c552b7610b1da5c1bd703d75
---
README.rst | 30 +++++++++++++++++++++++++++++-
doc/source/contributing.rst | 6 +++++-
doc/source/index.rst | 4 ++--
doc/source/installation.rst | 7 +------
doc/source/readme.rst | 2 +-
doc/source/usage.rst | 8 +++++++-
6 files changed, 45 insertions(+), 12 deletions(-)
diff --git a/README.rst b/README.rst
index 9c61274..43b08cf 100644
--- a/README.rst
+++ b/README.rst
@@ -34,9 +34,37 @@ in the openstack-infra/config git repository and add sections like:
branch-designator: ''
branch-override: default
-To the ``jobs`` list for your project. Refer to
+to the ``jobs`` list for your project. Refer to
https://review.openstack.org/#/c/76381 for an example.
+Then update ``modules/openstack_project/files/zuul/layout.yaml`` by
+adding the new check test to the global list of jobs (to make it
+non-voting to start), and then to your project and to oslo.test.
+
+::
+
+ - name: check-oslo.test-dsvm-oslo.messaging
+ voting: false
+
+::
+
+ - name: openstack/oslo.messaging
+ ...
+ check:
+ ...
+ - check-oslo.test-dsvm-oslo.messaging
+ ...
+
+::
+
+ - name: openstack/oslo.test
+ ...
+ check:
+ ...
+ - check-oslo.test-dsvm-oslo.messaging
+ ...
+
+
Locally
-------
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
index 8cb3146..2ca75d1 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@@ -1 +1,5 @@
-.. include:: ../../CONTRIBUTING.rst
\ No newline at end of file
+==============
+ Contributing
+==============
+
+.. include:: ../../CONTRIBUTING.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 6394002..c7a7c67 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -3,8 +3,8 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to 's documentation!
-========================================================
+Welcome to oslo.test's documentation!
+=====================================
Contents:
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 5c01c7a..7e0ab67 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -4,9 +4,4 @@ Installation
At the command line::
- $ pip install
-
-Or, if you have virtualenvwrapper installed::
-
- $ mkvirtualenv
- $ pip install
\ No newline at end of file
+ $ pip install oslotest
diff --git a/doc/source/readme.rst b/doc/source/readme.rst
index 6b2b3ec..a6210d3 100644
--- a/doc/source/readme.rst
+++ b/doc/source/readme.rst
@@ -1 +1 @@
-.. include:: ../README.rst
\ No newline at end of file
+.. include:: ../../README.rst
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
index de775e6..a8ccdc4 100644
--- a/doc/source/usage.rst
+++ b/doc/source/usage.rst
@@ -4,4 +4,10 @@ Usage
To use in a project::
- import test
\ No newline at end of file
+ from oslotest import base
+
+
+ class MyTest(base.BaseTestCase):
+
+ def test_something(self):
+ self.assertTrue(True)