~ubuntu-branches/ubuntu/trusty/cinder/trusty

« back to all changes in this revision

Viewing changes to doc/generate_autodoc_index.sh

• browse files at revision 1
• compare with another revision
• download diff
• download tarball
• view history from revision 1

Show diffs side-by-side

added

removed

doc/generate_autodoc_index.sh

 

1

#!/bin/sh

 

2

 

 

3

SOURCEDIR=doc/source/api

 

4

 

 

5

if [ ! -d ${SOURCEDIR} ] ; then

 

6

    mkdir -p ${SOURCEDIR}

 

7

fi

 

8

 

 

9

for x in `./doc/find_autodoc_modules.sh`;

 

10

do

 

11

  echo "Generating ${SOURCEDIR}/${x}.rst"

 

12

  echo "${SOURCEDIR}/${x}.rst" >> .autogenerated 

 

13

  heading="The :mod:\`${x}\` Module"

 

14

  # Figure out how long the heading is

 

15

  # and make sure to emit that many '=' under

 

16

  # it to avoid heading format errors

 

17

  # in Sphinx.

 

18

  heading_len=$(echo "$heading" | wc -c)

 

19

  underline=$(head -c $heading_len < /dev/zero | tr '\0' '=')

 

20

  ( cat <<EOF

 

21

${heading}

 

22

${underline}

 

23

 

 

24

.. automodule:: ${x}

 

25

  :members:

 

26

  :undoc-members:

 

27

  :show-inheritance:

 

28

EOF

 

29

) > ${SOURCEDIR}/${x}.rst

 

30

 

 

31

done

 

32

 

 

33

if [ ! -f ${SOURCEDIR}/autoindex.rst ] ; then

 

34

 

 

35

    cat > ${SOURCEDIR}/autoindex.rst <<EOF 

 

36

.. toctree::

 

37

   :maxdepth: 1

 

38

 

 

39

EOF

 

40

    for f in `cat .autogenerated | sort` ; do

 

41

        relative=`echo ${f} | sed -e 's$^'${SOURCEDIR}'/$$'`

 

42

        echo "   ${relative}" >> ${SOURCEDIR}/autoindex.rst

 

43

    done

 

44

 

 

45

    echo ${SOURCEDIR}/autoindex.rst >> .autogenerated

 

46

fi

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1