X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f443dae91032b57496bd1b516e3013b49e5dbf5d..00eb4a59a0a98fbe1ffef38f52562872631a8e76:/docs/Build.sh diff --git a/docs/Build.sh b/docs/Build.sh index e39cf57904..d51e6edc09 100755 --- a/docs/Build.sh +++ b/docs/Build.sh @@ -2,17 +2,70 @@ # # Simplistic script to rebuild our documentation with sphinx-build +# Python needs to find simgrid on my machine, but not ctest -- sorry for the hack +if [ -e /opt/simgrid ] ; then chmod +x /opt/simgrid; fi + set -e if [ "x$1" != 'xdoxy' -a -e build/xml ] ; then - echo "(Doxygen not rerun)" + echo "Doxygen not rerun: 'doxy' was not provided as an argument" else rm -rf build/xml source/api/ cd source; doxygen; cd .. fi -sphinx-build -M html source build ${SPHINXOPTS} -cat source/img/graphical-toc.svg \ - | perl -pe 's/(xlink:href="http)/target="_top" $1/' \ - | perl -pe 's/(xlink:href=".*?.html)/target="_top" $1/' \ - > build/html/graphical-toc.svg +if [ "x$1" != 'xjava' -a -e source/java ] ; then + echo "javasphinx not rerun: 'java' was not provided as an argument" +else + rm -rf source/java + javasphinx-apidoc --force -o source/java/ ../src/bindings/java/org/simgrid/msg + rm -f source/java/packages.rst # api_generated/source_java_packages.rst + rm -f source/java/org/simgrid/msg/package-index.rst # api_generated/source_java_org_simgrid_msg_package-index.rst + for f in source/java/org/simgrid/msg/* ; do + # Add the package name to the page titles + (echo -n "class org.simgrid.msg."; cat $f )>tmp + mv tmp $f + sed -i 's/==/========================/' $f # That's the right length knowing that I add 'class org.simgrid.msg.' + done +# sed -i 's/^.. java:type:: public class /.. java:type:: public class org.simgrid.msg/' source/java/org/simgrid/msg/* + echo "javasphinx relaunched" +fi + +PYTHONPATH=../lib sphinx-build -M html source build ${SPHINXOPTS} + +set +x + +perl -pe 's/(xlink:href="(?:http|.*\.html))/target="_top" $1/' \ + source/img/graphical-toc.svg > build/html/graphical-toc.svg + +echo "List of missing references:" +for f in $( (grep '' build/xml/msg_8h.xml; \ + grep '' build/xml/namespacesimgrid_1_1s4u.xml; \ + grep ']*>//g' | sort ) +do + + if grep $f source/*rst | grep -q '.. doxygen[^::]*:: '"$f"'$' || + grep $f source/*rst | grep -q '.. doxygen[^::]*:: simgrid::[^:]*::[^:]*::'"$f"'$' ; then : +# echo "$f documented" + else + if grep -q $f ignored_symbols ; then : +# echo "$f ignored" # not documented + else + echo "$f" + fi + fi +done + +if [ -e /opt/simgrid ] ; then chmod -x /opt/simgrid; fi + +set +e # Don't fail +if [ -e /usr/bin/linkchecker ] ; then + linkchecker --no-status -o csv --ignore-url='.*\.css$' --ignore-url=public/java/org build/html \ + | grep -v '^#' \ + | grep -v 'urlname;parentname;baseref;result;warningstring' + echo "done." +else + echo "Install linkchecker to have it executed when you build the doc." +fi +