~rlane/nova/ldapimprovements

« back to all changes in this revision

Viewing changes to doc/generate_autodoc_index.sh

  • Committer: Ryan Lane
  • Date: 2010-11-24 15:46:32 UTC
  • mfrom: (382.48.1 trunk)
  • Revision ID: laner@controller-20101124154632-zh7kwjuyyd02a2lh
MergeĀ fromĀ trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
#!/bin/sh
 
2
 
 
3
SOURCEDIR=source/api
 
4
 
 
5
if [ ! -d ${SOURCEDIR} ] ; then
 
6
    mkdir -p ${SOURCEDIR}
 
7
fi
 
8
 
 
9
for x in `./find_autodoc_modules.sh`;
 
10
do
 
11
  echo "Generating ${SOURCEDIR}/${x}.rst"
 
12
  echo "${SOURCEDIR}/${x}.rst" >> .autogenerated 
 
13
  ( cat <<EOF
 
14
The :mod:\`${x}\` Module
 
15
==============================================================================
 
16
.. automodule:: ${x}
 
17
  :members:
 
18
  :undoc-members:
 
19
  :show-inheritance:
 
20
EOF
 
21
) > ${SOURCEDIR}/${x}.rst
 
22
 
 
23
done
 
24
 
 
25
if [ ! -f ${SOURCEDIR}/autoindex.rst ] ; then
 
26
 
 
27
    cat > ${SOURCEDIR}/autoindex.rst <<EOF 
 
28
.. toctree::
 
29
   :maxdepth: 1
 
30
 
 
31
EOF
 
32
    for f in `cat .autogenerated | sort` ; do
 
33
        relative=`echo ${f} | sed -e 's$^'${SOURCEDIR}'/$$'`
 
34
        echo "   ${relative}" >> ${SOURCEDIR}/autoindex.rst
 
35
    done
 
36
 
 
37
    echo ${SOURCEDIR}/autoindex.rst >> .autogenerated
 
38
fi