X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6c8dd229d394fdaf20facf604f7be86a5df1e368..d3bc89e18d60e0e1f5c0da2d9357499a0078317f:/docs/Build.sh diff --git a/docs/Build.sh b/docs/Build.sh index 6ef952ae57..1311132a98 100755 --- a/docs/Build.sh +++ b/docs/Build.sh @@ -1,29 +1,58 @@ -#! /bin/sh +#! /bin/bash # +# Copyright (c) 2018-2022. The SimGrid Team. All rights reserved. + +# This program is free software; you can redistribute it and/or modify it +# under the terms of the license (GNU LGPL) which comes with this package. + # 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 set -e +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 + set -x rm -rf build/xml source/api/ - cd source; doxygen; cd .. + (cd source; doxygen 2>&1; cd ..) | (grep -v "is not documented." || true) # XXXXX Reduce the verbosity for now + set +x +fi + +if [ "x$1" != 'xlogs' ] && [ -e build/log_categories.rst ] ; then + echo "Log categories not extracted: 'logs' was not provided as an argument" +else + set -x + perl ./bin/extract_logs_hierarchy.pl ../ > build/log_categories.rst + set +x 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 + set -x 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 +60,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 @@ -41,7 +70,8 @@ perl -pe 's/(xlink:href="(?:http|.*\.html))/target="_top" $1/' \ echo echo "Undocumented examples:" for ex in $( (cd .. ; \ - find examples/s4u/ -name '*.cpp'; \ + find examples/cpp/ -name '*.cpp'; \ + find examples/c/ -name '*.c'; \ find examples/python -name '*.py'; \ ) | sort ) do