adding version to project, setting up autobuild of docs with ./run_tests.sh --docs

3 files changed, 57 insertions, 2 deletions

diff --git a/doc/source/conf.py b/doc/source/conf.py
index d296042a..164c6560 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -12,6 +12,7 @@
 # serve to show the default.
 
 import sys, os
+from django_openstack import version as horizon_version
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -56,9 +57,9 @@ copyright = u'2011, OpenStack, LLC'
 # built documents.
 #
 # The short X.Y version.
-version = '1.0'
+version = horizon_version.canonical_version_string()
 # The full version, including alpha/beta/rc tags.
-release = '1.0'
+release = horizon_version.canonical_version_string()
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 33e91eb4..cb6e3278 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -14,6 +14,7 @@
       License for the specific language governing permissions and limitations
       under the License.
 
+========================
 Horizon for Contributors
 ========================
 
@@ -23,11 +24,32 @@ interface to OpenStack services including Nova, Swift, Keystone, and Quantum.
 
 This document describes horizon for contributors of the project.
 
+Project Structure
+=================
+
+This project is a bit different from other Openstack projects in that it has
+two very distinct components underneath it:
+
+* django-openstack
+* openstack-dashboard
+
+Django-openstack holds the generic libraries and components that can be
+used in any Django project. In testing, this component is set up with
+buildout (see run_tests.sh), and any dependencies that get added need to
+be added to the django-openstack/buildout.cfg file.
+
+Openstack-dashboard is a reference django project that uses django-openstack
+and is built with a virtualenv and tested through that environment. If
+depdendencies are added that the reference django project needs, they
+should be added to openstack-dashboard/tools/pip-requires.
+
 Contents:
+---------
 
 .. toctree::
    :maxdepth: 1
 
+   testing
 
 Developer Docs
 --------------
diff --git a/doc/source/testing.rst b/doc/source/testing.rst
new file mode 100644
index 00000000..bab32a82
--- /dev/null
+++ b/doc/source/testing.rst
@@ -0,0 +1,32 @@
+..
+      Copyright 2011 OpenStack, LLC
+      All Rights Reserved.
+
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+=====================
+Testing the Dashboard
+=====================
+
+Testing the dashbaord is a bit more complex due to having the two projects
+in the same repository.
+
+The run_tests.sh script invokes tests and analysis on both of these
+components in it's process, and is what Jenkins uses to verify the
+stability of the project.
+
+To run the tests::
+
+    $ ./run_tests.sh
+
+