summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndy Smith <code@term.ie>2010-11-08 02:00:48 +0900
committerAndy Smith <code@term.ie>2010-11-08 02:00:48 +0900
commit006b3ab0c7b8699e63df2a2884c53abd3ba37658 (patch)
treeebf2df65e0c0f0fad25af22c2bb69ed9a57548e0
parente54bddd0512f3c788c72f5e151868bae0be869ef (diff)
downloadnova-006b3ab0c7b8699e63df2a2884c53abd3ba37658.tar.gz
nova-006b3ab0c7b8699e63df2a2884c53abd3ba37658.tar.xz
nova-006b3ab0c7b8699e63df2a2884c53abd3ba37658.zip
Switch to module-per-file for the module index.
Rename development guide to development reference.
-rw-r--r--doc/Makefile7
-rwxr-xr-xdoc/generate_autodoc_index.sh15
-rw-r--r--doc/source/devref/api.rst (renamed from doc/source/devguide/api.rst)0
-rw-r--r--doc/source/devref/architecture.rst (renamed from doc/source/devguide/architecture.rst)0
-rw-r--r--doc/source/devref/auth.rst (renamed from doc/source/devguide/auth.rst)0
-rw-r--r--doc/source/devref/cloudpipe.rst (renamed from doc/source/devguide/cloudpipe.rst)0
-rw-r--r--doc/source/devref/compute.rst (renamed from doc/source/devguide/compute.rst)0
-rw-r--r--doc/source/devref/database.rst (renamed from doc/source/devguide/database.rst)0
-rw-r--r--doc/source/devref/development.environment.rst (renamed from doc/source/devguide/development.environment.rst)0
-rw-r--r--doc/source/devref/fakes.rst (renamed from doc/source/devguide/fakes.rst)0
-rw-r--r--doc/source/devref/glance.rst (renamed from doc/source/devguide/glance.rst)0
-rw-r--r--doc/source/devref/index.rst (renamed from doc/source/devguide/index.rst)6
-rw-r--r--doc/source/devref/network.rst (renamed from doc/source/devguide/network.rst)0
-rw-r--r--doc/source/devref/nova.rst (renamed from doc/source/devguide/nova.rst)0
-rw-r--r--doc/source/devref/objectstore.rst (renamed from doc/source/devguide/objectstore.rst)0
-rw-r--r--doc/source/devref/scheduler.rst (renamed from doc/source/devguide/scheduler.rst)0
-rw-r--r--doc/source/devref/services.rst (renamed from doc/source/devguide/services.rst)0
-rw-r--r--doc/source/devref/volume.rst (renamed from doc/source/devguide/volume.rst)0
-rw-r--r--doc/source/index.rst2
19 files changed, 21 insertions, 9 deletions
diff --git a/doc/Makefile b/doc/Makefile
index ed3172282..f1391ea41 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -33,11 +33,12 @@ help:
clean:
-rm -rf $(BUILDDIR)/*
-rm -rf nova.sqlite
- -rm $(SPHINXSOURCE)/code.rst
+ cat .autogenerated | xargs rm
+ rm .autogenerated
module_autodoc: generate_autodoc_index.sh
- @echo "Generating module autodoc index."
- ./generate_autodoc_index.sh > $(SPHINXSOURCE)/code.rst
+ @echo "Generating module autodocs."
+ ./generate_autodoc_index.sh
source/code.rst: module_autodoc
@# pass
diff --git a/doc/generate_autodoc_index.sh b/doc/generate_autodoc_index.sh
index 5cc1e42e8..1dfd1a359 100755
--- a/doc/generate_autodoc_index.sh
+++ b/doc/generate_autodoc_index.sh
@@ -1,8 +1,19 @@
#!/bin/sh
+SOURCEDIR=source
for x in `./find_autodoc_modules.sh`;
do
- echo ".. automodule:: ${x}"
- echo " :members:"
+ echo "Generating ${SOURCEDIR}/${x}.rst"
+ echo "${SOURCEDIR}/${x}.rst" >> .autogenerated
+ ( cat <<EOF
+The :mod:\`${x}\` Module
+=====================
+.. automodule:: ${x}
+ :members:
+ :undoc-members:
+ :show-inheritance:
+EOF
+) > ${SOURCEDIR}/${x}.rst
+
done
diff --git a/doc/source/devguide/api.rst b/doc/source/devref/api.rst
index cad0e820a..cad0e820a 100644
--- a/doc/source/devguide/api.rst
+++ b/doc/source/devref/api.rst
diff --git a/doc/source/devguide/architecture.rst b/doc/source/devref/architecture.rst
index 1e23e1361..1e23e1361 100644
--- a/doc/source/devguide/architecture.rst
+++ b/doc/source/devref/architecture.rst
diff --git a/doc/source/devguide/auth.rst b/doc/source/devref/auth.rst
index 77d97f68b..77d97f68b 100644
--- a/doc/source/devguide/auth.rst
+++ b/doc/source/devref/auth.rst
diff --git a/doc/source/devguide/cloudpipe.rst b/doc/source/devref/cloudpipe.rst
index 5264a0f39..5264a0f39 100644
--- a/doc/source/devguide/cloudpipe.rst
+++ b/doc/source/devref/cloudpipe.rst
diff --git a/doc/source/devguide/compute.rst b/doc/source/devref/compute.rst
index e4c6c6ae7..e4c6c6ae7 100644
--- a/doc/source/devguide/compute.rst
+++ b/doc/source/devref/compute.rst
diff --git a/doc/source/devguide/database.rst b/doc/source/devref/database.rst
index b58ea147d..b58ea147d 100644
--- a/doc/source/devguide/database.rst
+++ b/doc/source/devref/database.rst
diff --git a/doc/source/devguide/development.environment.rst b/doc/source/devref/development.environment.rst
index 34104c964..34104c964 100644
--- a/doc/source/devguide/development.environment.rst
+++ b/doc/source/devref/development.environment.rst
diff --git a/doc/source/devguide/fakes.rst b/doc/source/devref/fakes.rst
index 61622754c..61622754c 100644
--- a/doc/source/devguide/fakes.rst
+++ b/doc/source/devref/fakes.rst
diff --git a/doc/source/devguide/glance.rst b/doc/source/devref/glance.rst
index 3d0f4ebec..3d0f4ebec 100644
--- a/doc/source/devguide/glance.rst
+++ b/doc/source/devref/glance.rst
diff --git a/doc/source/devguide/index.rst b/doc/source/devref/index.rst
index 6232a3181..a14460405 100644
--- a/doc/source/devguide/index.rst
+++ b/doc/source/devref/index.rst
@@ -15,8 +15,8 @@
License for the specific language governing permissions and limitations
under the License.
-Nova Development Guide
-======================
+Nova Development Reference
+==========================
Nova is written in python.
@@ -34,7 +34,7 @@ Contents
--------
.. toctree::
- :maxdepth: 1
+ :maxdepth: 3
services
database
diff --git a/doc/source/devguide/network.rst b/doc/source/devref/network.rst
index 318286383..318286383 100644
--- a/doc/source/devguide/network.rst
+++ b/doc/source/devref/network.rst
diff --git a/doc/source/devguide/nova.rst b/doc/source/devref/nova.rst
index 58125dc80..58125dc80 100644
--- a/doc/source/devguide/nova.rst
+++ b/doc/source/devref/nova.rst
diff --git a/doc/source/devguide/objectstore.rst b/doc/source/devref/objectstore.rst
index 4087b5dd0..4087b5dd0 100644
--- a/doc/source/devguide/objectstore.rst
+++ b/doc/source/devref/objectstore.rst
diff --git a/doc/source/devguide/scheduler.rst b/doc/source/devref/scheduler.rst
index df820c2f2..df820c2f2 100644
--- a/doc/source/devguide/scheduler.rst
+++ b/doc/source/devref/scheduler.rst
diff --git a/doc/source/devguide/services.rst b/doc/source/devref/services.rst
index 517a51901..517a51901 100644
--- a/doc/source/devguide/services.rst
+++ b/doc/source/devref/services.rst
diff --git a/doc/source/devguide/volume.rst b/doc/source/devref/volume.rst
index 19b750870..19b750870 100644
--- a/doc/source/devguide/volume.rst
+++ b/doc/source/devref/volume.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 4ef75c432..f96d5ff80 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -45,7 +45,7 @@ Contents
concepts.and.introduction
adminguide/index
- devguide/index
+ devref/index
reaching.out
Recommended System Configuration