X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/83acfa5389165446231f2b5006f4308b19f4ef10..6c8dd229d394fdaf20facf604f7be86a5df1e368:/docs/Build.sh diff --git a/docs/Build.sh b/docs/Build.sh index 03fc911c86..6ef952ae57 100755 --- a/docs/Build.sh +++ b/docs/Build.sh @@ -2,22 +2,25 @@ # # 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 +if [ "x$1" != 'xdoxy' -a -e build/xml ] ; then echo "Doxygen not rerun: 'doxy' was not provided as an argument" else rm -rf build/xml source/api/ cd source; doxygen; cd .. fi -if [ "x$1" != 'xjava' -a -e source/java ] ; then +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 - mv source/java/packages.rst api_generated/source_java_packages.rst - mv source/java/org/simgrid/msg/package-index.rst api_generated/source_java_org_simgrid_msg_package-index.rst + 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 @@ -28,30 +31,35 @@ else echo "javasphinx relaunched" fi -sphinx-build -M html source build ${SPHINXOPTS} +PYTHONPATH=../lib sphinx-build -M html source build ${SPHINXOPTS} set +x -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 +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` +echo +echo "Undocumented examples:" +for ex in $( (cd .. ; \ + find examples/s4u/ -name '*.cpp'; \ + find examples/python -name '*.py'; \ + ) | 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 + if grep -q "example-tab:: $ex" ../examples/README.rst ; then : +# echo "found example-tab:: $ex" + elif grep -q "showfile:: $ex" ../examples/README.rst ; then : else - echo "$f" + echo $ex fi - fi -done \ No newline at end of file +done + +set +e # Don't fail +if [ -e /usr/bin/linkchecker ] ; then + linkchecker --no-status -o csv --ignore-url='.*\.css$' --ignore-url=build/html/_modules --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 +