quieter doc building (less warnings).
This commit is contained in:
parent
7e8e4a74f4
commit
913d078469
@ -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."
|
||||
|
@ -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
|
||||
|
||||
|
@ -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 <<EOF
|
||||
The :mod:\`${x}\` Module
|
||||
=====================
|
||||
==============================================================================
|
||||
.. automodule:: ${x}
|
||||
:members:
|
||||
:undoc-members:
|
||||
@ -17,3 +22,17 @@ EOF
|
||||
|
||||
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
|
||||
|
@ -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:
|
||||
|
@ -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:
|
||||
|
Loading…
Reference in New Issue
Block a user