Merge with trunk.

doc/.autogenerated

@@ -0,0 +1,97 @@
+source/api/nova..adminclient.rst
+source/api/nova..api.cloud.rst
+source/api/nova..api.ec2.admin.rst
+source/api/nova..api.ec2.apirequest.rst
+source/api/nova..api.ec2.cloud.rst
+source/api/nova..api.ec2.images.rst
+source/api/nova..api.ec2.metadatarequesthandler.rst
+source/api/nova..api.openstack.auth.rst
+source/api/nova..api.openstack.backup_schedules.rst
+source/api/nova..api.openstack.faults.rst
+source/api/nova..api.openstack.flavors.rst
+source/api/nova..api.openstack.images.rst
+source/api/nova..api.openstack.servers.rst
+source/api/nova..api.openstack.sharedipgroups.rst
+source/api/nova..auth.dbdriver.rst
+source/api/nova..auth.fakeldap.rst
+source/api/nova..auth.ldapdriver.rst
+source/api/nova..auth.manager.rst
+source/api/nova..auth.signer.rst
+source/api/nova..cloudpipe.pipelib.rst
+source/api/nova..compute.disk.rst
+source/api/nova..compute.instance_types.rst
+source/api/nova..compute.manager.rst
+source/api/nova..compute.monitor.rst
+source/api/nova..compute.power_state.rst
+source/api/nova..context.rst
+source/api/nova..crypto.rst
+source/api/nova..db.api.rst
+source/api/nova..db.sqlalchemy.api.rst
+source/api/nova..db.sqlalchemy.models.rst
+source/api/nova..db.sqlalchemy.session.rst
+source/api/nova..exception.rst
+source/api/nova..fakerabbit.rst
+source/api/nova..flags.rst
+source/api/nova..image.service.rst
+source/api/nova..manager.rst
+source/api/nova..network.linux_net.rst
+source/api/nova..network.manager.rst
+source/api/nova..objectstore.bucket.rst
+source/api/nova..objectstore.handler.rst
+source/api/nova..objectstore.image.rst
+source/api/nova..objectstore.stored.rst
+source/api/nova..process.rst
+source/api/nova..quota.rst
+source/api/nova..rpc.rst
+source/api/nova..scheduler.chance.rst
+source/api/nova..scheduler.driver.rst
+source/api/nova..scheduler.manager.rst
+source/api/nova..scheduler.simple.rst
+source/api/nova..server.rst
+source/api/nova..service.rst
+source/api/nova..test.rst
+source/api/nova..tests.access_unittest.rst
+source/api/nova..tests.api.fakes.rst
+source/api/nova..tests.api.openstack.fakes.rst
+source/api/nova..tests.api.openstack.test_api.rst
+source/api/nova..tests.api.openstack.test_auth.rst
+source/api/nova..tests.api.openstack.test_faults.rst
+source/api/nova..tests.api.openstack.test_flavors.rst
+source/api/nova..tests.api.openstack.test_images.rst
+source/api/nova..tests.api.openstack.test_ratelimiting.rst
+source/api/nova..tests.api.openstack.test_servers.rst
+source/api/nova..tests.api.openstack.test_sharedipgroups.rst
+source/api/nova..tests.api.test_wsgi.rst
+source/api/nova..tests.api_integration.rst
+source/api/nova..tests.api_unittest.rst
+source/api/nova..tests.auth_unittest.rst
+source/api/nova..tests.cloud_unittest.rst
+source/api/nova..tests.compute_unittest.rst
+source/api/nova..tests.declare_flags.rst
+source/api/nova..tests.fake_flags.rst
+source/api/nova..tests.flags_unittest.rst
+source/api/nova..tests.network_unittest.rst
+source/api/nova..tests.objectstore_unittest.rst
+source/api/nova..tests.process_unittest.rst
+source/api/nova..tests.quota_unittest.rst
+source/api/nova..tests.real_flags.rst
+source/api/nova..tests.rpc_unittest.rst
+source/api/nova..tests.runtime_flags.rst
+source/api/nova..tests.scheduler_unittest.rst
+source/api/nova..tests.service_unittest.rst
+source/api/nova..tests.twistd_unittest.rst
+source/api/nova..tests.validator_unittest.rst
+source/api/nova..tests.virt_unittest.rst
+source/api/nova..tests.volume_unittest.rst
+source/api/nova..twistd.rst
+source/api/nova..utils.rst
+source/api/nova..validate.rst
+source/api/nova..virt.connection.rst
+source/api/nova..virt.fake.rst
+source/api/nova..virt.images.rst
+source/api/nova..virt.libvirt_conn.rst
+source/api/nova..virt.xenapi.rst
+source/api/nova..volume.driver.rst
+source/api/nova..volume.manager.rst
+source/api/nova..wsgi.rst
+source/api/autoindex.rst

doc/Makefile

@@ -4,16 +4,19 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
+SPHINXSOURCE 	= source
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = build
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINXSOURCE)
 
 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
 
+.DEFAULT_GOAL 	= html
+
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
 	@echo "  html      to make standalone HTML files"
@@ -29,6 +32,11 @@ help:
 
 clean:
 	-rm -rf $(BUILDDIR)/*
+	-rm -rf nova.sqlite
+	if [ -f .autogenerated ] ; then \
+        cat .autogenerated | xargs rm ; \
+        rm .autogenerated ; \
+    fi
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

doc/README.rst

@@ -0,0 +1,33 @@
+=================
+Building the docs
+=================
+
+It is really easy. You'll need sphinx (the python one) and if you are using the virtualenv you'll need to install it in the virtualenv specifically so that it can load the nova modules.
+
+
+Use `make`
+==========
+
+Just type make::
+
+  % make
+
+Look in the Makefile for more targets.
+
+
+Manually
+========
+
+  1. Generate the code.rst file so that Sphinx will pull in our docstrings::
+     
+      % ./generate_autodoc_index.sh > source/code.rst
+
+  2. Run `sphinx_build`::
+
+      % sphinx-build -b html source build/html
+
+
+The docs have been built
+========================
+
+Check out the `build` directory to find them. Yay!