docs/Build.sh

   1 #! /bin/sh
   2 #
   3 # Simplistic script to rebuild our documentation with sphinx-build
   4
   5 set -e
   6
   7 if [ "x$1" != 'xdoxy' -a -e build/xml ] ; then
   8   echo "(Doxygen not rerun)"
   9 else
  10   rm -rf build/xml source/api/
  11   cd source; doxygen; cd ..
  12 fi
  13
  14 sphinx-build -M html source build ${SPHINXOPTS}
  15 cat source/img/graphical-toc.svg \
  16  | perl -pe 's/(xlink:href="http)/target="_top" $1/' \
  17  | perl -pe 's/(xlink:href=".*?.html)/target="_top" $1/' \
  18  > build/html/graphical-toc.svg
  19
  20
  21 echo "List of missing references:"
  22 for f in `(grep '<name>' build/xml/msg_8h.xml; \
  23            grep '<name>' build/xml/namespacesimgrid_1_1s4u.xml; \
  24            grep '<innerclass refid=' build/xml/namespacesimgrid_1_1s4u.xml) |sed 's/<[^>]*>//g'|sort`
  25 do
  26
  27   if grep $f source/*rst | grep -q '.. doxygen[^::]*:: '"$f"'$' ||
  28      grep $f source/*rst | grep -q '.. doxygen[^::]*:: simgrid::[^:]*::[^:]*::'"$f"'$'  ; then :
  29 #    echo "$f documented"
  30   else
  31     if grep -q $f ignored_symbols ; then :
  32 #      echo "$f ignored" # not documented
  33     else
  34       echo "$f"
  35     fi
  36   fi
  37 done