X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b041db512dacfbae316cc83ce717d27d0f4200fb..47d230829f5847d1aed4f7aeb70ecee7a38e590d:/docs/Build.sh diff --git a/docs/Build.sh b/docs/Build.sh index 8bb15b214d..cc536cb689 100755 --- a/docs/Build.sh +++ b/docs/Build.sh @@ -1,29 +1,42 @@ -#! /bin/sh +#! /bin/bash # # Simplistic script to rebuild our documentation with sphinx-build +# If you are missing some dependencies, try: pip3 install --requirement docs/requirements.txt + # 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 +if [ -e /opt/simgrid ] ; then chmod +x /opt/simgrid; fi -set -e +set -ex +set -o pipefail -if [ "x$1" != 'xdoxy' -a -e build/xml ] ; then +if [ "x$1" != 'xdoxy' ] && [ -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 .. + (cd source; doxygen 2>&1; cd ..) | grep -v "is not documented." #  XXXXX Reduce the verbosity for now fi -if [ "x$1" != 'xjava' -a -e source/java ] ; then +if [ "x$1" != 'xjava' ] && [ -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 + + # Use that script without installing javasphinx: javasphinx-apidoc --force -o source/java/ ../src/bindings/java/org/simgrid/msg + PYTHONPATH=${PYTHONPATH}:source/_ext/javasphinx python3 - --force -o source/java/ ../src/bindings/java/org/simgrid/msg <tmp + (printf "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 @@ -31,7 +44,7 @@ else echo "javasphinx relaunched" fi -PYTHONPATH=../lib sphinx-build -M html source build ${SPHINXOPTS} +PYTHONPATH=../lib:source/_ext/javasphinx sphinx-build -M html source build ${SPHINXOPTS} 2>&1 set +x @@ -42,6 +55,7 @@ echo echo "Undocumented examples:" for ex in $( (cd .. ; \ find examples/s4u/ -name '*.cpp'; \ + find examples/c/ -name '*.c'; \ find examples/python -name '*.py'; \ ) | sort ) do @@ -54,7 +68,7 @@ do done set +e # Don't fail -if [ -e /usr/bin/linkchecker ] ; then +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'