From 913d078469720c514a19c01ffe97838c455132b7 Mon Sep 17 00:00:00 2001 From: Todd Willey Date: Sun, 7 Nov 2010 14:58:02 -0500 Subject: [PATCH] quieter doc building (less warnings). --- doc/Makefile | 6 ++++-- doc/find_autodoc_modules.sh | 2 +- doc/generate_autodoc_index.sh | 23 +++++++++++++++++++++-- doc/source/devref/cloudpipe.rst | 9 ++++++--- doc/source/devref/services.rst | 2 ++ 5 files changed, 34 insertions(+), 8 deletions(-) diff --git a/doc/Makefile b/doc/Makefile index f1391ea413e0..32323e731711 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -33,8 +33,10 @@ help: clean: -rm -rf $(BUILDDIR)/* -rm -rf nova.sqlite - cat .autogenerated | xargs rm - rm .autogenerated + if [ -f .autogenerated ] ; then \ + cat .autogenerated | xargs rm ; \ + rm .autogenerated ; \ + fi module_autodoc: generate_autodoc_index.sh @echo "Generating module autodocs." diff --git a/doc/find_autodoc_modules.sh b/doc/find_autodoc_modules.sh index b44f060fb82e..c612b0084068 100755 --- a/doc/find_autodoc_modules.sh +++ b/doc/find_autodoc_modules.sh @@ -8,7 +8,7 @@ for x in `find ${NOVA_DIR} -name '*.py'`; do if [ `basename ${x} .py` == "__init__" ] ; then continue fi - relative=nova`echo ${x} | sed -e 's$^'${NOVA_DIR}'$$' -e 's/.py$//' -e 's$/$.$g'` + relative=nova.`echo ${x} | sed -e 's$^'${NOVA_DIR}'$$' -e 's/.py$//' -e 's$/$.$g'` modules="${modules} ${relative}" done diff --git a/doc/generate_autodoc_index.sh b/doc/generate_autodoc_index.sh index 1dfd1a359a3a..4e2870bfc929 100644 --- a/doc/generate_autodoc_index.sh +++ b/doc/generate_autodoc_index.sh @@ -1,5 +1,10 @@ #!/bin/sh -SOURCEDIR=source + +SOURCEDIR=source/api + +if [ ! -d ${SOURCEDIR} ] ; then + mkdir -p ${SOURCEDIR} +fi for x in `./find_autodoc_modules.sh`; do @@ -7,7 +12,7 @@ do echo "${SOURCEDIR}/${x}.rst" >> .autogenerated ( cat < ${SOURCEDIR}/autoindex.rst <> ${SOURCEDIR}/autoindex.rst + done + + echo ${SOURCEDIR}/autoindex.rst >> .autogenerated +fi diff --git a/doc/source/devref/cloudpipe.rst b/doc/source/devref/cloudpipe.rst index d6d456a6b8ac..31bd85e8178f 100644 --- a/doc/source/devref/cloudpipe.rst +++ b/doc/source/devref/cloudpipe.rst @@ -65,27 +65,30 @@ If the use_project_ca flag is set (required to for cloudpipes to work securely), The :mod:`nova.cloudpipe.pipelib` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: nova.cloudpipe.pipelib + :noindex: :members: :undoc-members: :show-inheritance: The :mod:`nova.api.cloudpipe` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: nova.api.cloudpipe + :noindex: :members: :undoc-members: :show-inheritance: The :mod:`nova.crypto` Module -~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: nova.crypto + :noindex: :members: :undoc-members: :show-inheritance: diff --git a/doc/source/devref/services.rst b/doc/source/devref/services.rst index fe84e20d8ebe..f5bba5c126d5 100644 --- a/doc/source/devref/services.rst +++ b/doc/source/devref/services.rst @@ -29,6 +29,7 @@ The :mod:`nova.service` Module ------------------------------ .. automodule:: nova.service + :noindex: :members: :undoc-members: :show-inheritance: @@ -38,6 +39,7 @@ The :mod:`nova.manager` Module ------------------------------ .. automodule:: nova.manager + :noindex: :members: :undoc-members: :show-inheritance: