X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b31da7a1c205fdc49fcbef81a505fd2248e8b152..78fedc4d8f9b0daf04101bd76017c27285a77251:/docs/Build.sh diff --git a/docs/Build.sh b/docs/Build.sh index 2b42bfda89..24aa30c5a5 100755 --- a/docs/Build.sh +++ b/docs/Build.sh @@ -1,5 +1,10 @@ #! /bin/bash # +# Copyright (c) 2018-2021. 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 @@ -13,15 +18,26 @@ set -o pipefail 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 2>&1; cd ..) | grep -v "is not documented." #  XXXXX Reduce the verbosity for now + (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' ] && [ -e source/java ] ; then echo "javasphinx not rerun: 'java' was not provided as an argument" else + set -x rm -rf source/java - + # 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 <&1 \ - | grep -v 'WARNING: cpp:identifier reference target not found: simgrid$' \ - | grep -v 'WARNING: cpp:identifier reference target not found: simgrid::s4u$' \ - | grep -v 'WARNING: cpp:identifier reference target not found: boost' +PYTHONPATH=../lib:source/_ext/javasphinx sphinx-build -M html source build ${SPHINXOPTS} 2>&1 set +x @@ -57,8 +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/c/ -name '*.c'; \ + find examples/cpp/ -name '*.cpp'; \ + find examples/c/ -name '*.c'; \ find examples/python -name '*.py'; \ ) | sort ) do