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: 'doxy' was not provided as an argument"
   9 else
  10   rm -rf build/xml source/api/
  11   cd source; doxygen; cd ..
  12 fi
  13
  14 if [ "x$1" != 'xjava' -a -e source/java ] ; then
  15   echo "javasphinx not rerun: 'java' was not provided as an argument"
  16 else
  17   rm -rf source/java
  18   javasphinx-apidoc --force -o source/java/ ../src/bindings/java/org/simgrid/msg
  19   rm source/java/packages.rst # source/java/org/simgrid/msg/package-index.rst
  20 #  sed -i 's/^.. java:type:: public class /.. java:type:: public class org.simgrid.msg/' source/java/org/simgrid/msg/*
  21   echo "javasphinx relaunched"
  22 fi
  23
  24 sphinx-build -M html source build ${SPHINXOPTS}
  25 cat source/img/graphical-toc.svg \
  26  | perl -pe 's/(xlink:href="http)/target="_top" $1/' \
  27  | perl -pe 's/(xlink:href=".*?.html)/target="_top" $1/' \
  28  > build/html/graphical-toc.svg
  29
  30
  31 echo "List of missing references:"
  32 for f in `(grep '<name>' build/xml/msg_8h.xml; \
  33            grep '<name>' build/xml/namespacesimgrid_1_1s4u.xml; \
  34            grep '<innerclass refid=' build/xml/namespacesimgrid_1_1s4u.xml ; \
  35           ) |sed 's/<[^>]*>//g'|sort`
  36 do
  37
  38   if grep $f source/*rst | grep -q '.. doxygen[^::]*:: '"$f"'$' ||
  39      grep $f source/*rst | grep -q '.. doxygen[^::]*:: simgrid::[^:]*::[^:]*::'"$f"'$'  ; then :
  40 #    echo "$f documented"
  41   else
  42     if grep -q $f ignored_symbols ; then :
  43 #      echo "$f ignored" # not documented
  44     else
  45       echo "$f"
  46     fi
  47   fi
  48 done