Switch to module-per-file for the module index.

Rename development guide to development reference.
This commit is contained in:
Andy Smith
2010-11-08 02:00:48 +09:00
parent 1bdcd99338
commit 11780c491a
19 changed files with 21 additions and 9 deletions

View File

@@ -33,11 +33,12 @@ help:
clean: clean:
-rm -rf $(BUILDDIR)/* -rm -rf $(BUILDDIR)/*
-rm -rf nova.sqlite -rm -rf nova.sqlite
-rm $(SPHINXSOURCE)/code.rst cat .autogenerated | xargs rm
rm .autogenerated
module_autodoc: generate_autodoc_index.sh module_autodoc: generate_autodoc_index.sh
@echo "Generating module autodoc index." @echo "Generating module autodocs."
./generate_autodoc_index.sh > $(SPHINXSOURCE)/code.rst ./generate_autodoc_index.sh
source/code.rst: module_autodoc source/code.rst: module_autodoc
@# pass @# pass

View File

@@ -1,8 +1,19 @@
#!/bin/sh #!/bin/sh
SOURCEDIR=source
for x in `./find_autodoc_modules.sh`; for x in `./find_autodoc_modules.sh`;
do do
echo ".. automodule:: ${x}" echo "Generating ${SOURCEDIR}/${x}.rst"
echo " :members:" echo "${SOURCEDIR}/${x}.rst" >> .autogenerated
( cat <<EOF
The :mod:\`${x}\` Module
=====================
.. automodule:: ${x}
:members:
:undoc-members:
:show-inheritance:
EOF
) > ${SOURCEDIR}/${x}.rst
done done

View File

@@ -15,8 +15,8 @@
License for the specific language governing permissions and limitations License for the specific language governing permissions and limitations
under the License. under the License.
Nova Development Guide Nova Development Reference
====================== ==========================
Nova is written in python. Nova is written in python.
@@ -34,7 +34,7 @@ Contents
-------- --------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 3
services services
database database

View File

@@ -45,7 +45,7 @@ Contents
concepts.and.introduction concepts.and.introduction
adminguide/index adminguide/index
devguide/index devref/index
reaching.out reaching.out
Recommended System Configuration Recommended System Configuration