quieter doc building (less warnings).

This commit is contained in:
Todd Willey 2010-11-07 14:58:02 -05:00
parent 7e8e4a74f4
commit 913d078469
5 changed files with 34 additions and 8 deletions

View File

@ -33,8 +33,10 @@ help:
clean: clean:
-rm -rf $(BUILDDIR)/* -rm -rf $(BUILDDIR)/*
-rm -rf nova.sqlite -rm -rf nova.sqlite
cat .autogenerated | xargs rm if [ -f .autogenerated ] ; then \
rm .autogenerated cat .autogenerated | xargs rm ; \
rm .autogenerated ; \
fi
module_autodoc: generate_autodoc_index.sh module_autodoc: generate_autodoc_index.sh
@echo "Generating module autodocs." @echo "Generating module autodocs."

View File

@ -8,7 +8,7 @@ for x in `find ${NOVA_DIR} -name '*.py'`; do
if [ `basename ${x} .py` == "__init__" ] ; then if [ `basename ${x} .py` == "__init__" ] ; then
continue continue
fi 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}" modules="${modules} ${relative}"
done done

View File

@ -1,5 +1,10 @@
#!/bin/sh #!/bin/sh
SOURCEDIR=source
SOURCEDIR=source/api
if [ ! -d ${SOURCEDIR} ] ; then
mkdir -p ${SOURCEDIR}
fi
for x in `./find_autodoc_modules.sh`; for x in `./find_autodoc_modules.sh`;
do do
@ -7,7 +12,7 @@ do
echo "${SOURCEDIR}/${x}.rst" >> .autogenerated echo "${SOURCEDIR}/${x}.rst" >> .autogenerated
( cat <<EOF ( cat <<EOF
The :mod:\`${x}\` Module The :mod:\`${x}\` Module
===================== ==============================================================================
.. automodule:: ${x} .. automodule:: ${x}
:members: :members:
:undoc-members: :undoc-members:
@ -17,3 +22,17 @@ EOF
done done
if [ ! -f ${SOURCEDIR}/autoindex.rst ] ; then
cat > ${SOURCEDIR}/autoindex.rst <<EOF
.. toctree::
:maxdepth: 1
EOF
for f in `cat .autogenerated | sort` ; do
relative=`echo ${f} | sed -e 's$^'${SOURCEDIR}'/$$'`
echo " ${relative}" >> ${SOURCEDIR}/autoindex.rst
done
echo ${SOURCEDIR}/autoindex.rst >> .autogenerated
fi

View File

@ -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 The :mod:`nova.cloudpipe.pipelib` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.cloudpipe.pipelib .. automodule:: nova.cloudpipe.pipelib
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.api.cloudpipe` Module The :mod:`nova.api.cloudpipe` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.api.cloudpipe .. automodule:: nova.api.cloudpipe
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
The :mod:`nova.crypto` Module The :mod:`nova.crypto` Module
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: nova.crypto .. automodule:: nova.crypto
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

View File

@ -29,6 +29,7 @@ The :mod:`nova.service` Module
------------------------------ ------------------------------
.. automodule:: nova.service .. automodule:: nova.service
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -38,6 +39,7 @@ The :mod:`nova.manager` Module
------------------------------ ------------------------------
.. automodule:: nova.manager .. automodule:: nova.manager
:noindex:
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance: