X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/18278c24522cdb44cb578759dc34a1b39f591e22..3907e83884bae6278656e9cd2cb7ef92a8f707fb:/docs/Build.sh diff --git a/docs/Build.sh b/docs/Build.sh index 51ab88da50..fa133ad9a7 100755 --- a/docs/Build.sh +++ b/docs/Build.sh @@ -1,5 +1,10 @@ -#! /bin/sh +#! /bin/bash # +# Copyright (c) 2018-2023. 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 @@ -8,35 +13,26 @@ if [ -e /opt/simgrid ] ; then chmod +x /opt/simgrid; fi set -e +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; 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" != 'xjava' ] && [ -e source/java ] ; then - echo "javasphinx not rerun: 'java' was not provided as an argument" +if [ "x$1" != 'xlogs' ] && [ -e build/log_categories.rst ] ; then + echo "Log categories not extracted: 'logs' 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 - (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 -# sed -i 's/^.. java:type:: public class /.. java:type:: public class org.simgrid.msg/' source/java/org/simgrid/msg/* - echo "javasphinx relaunched" + set -x + perl ./bin/extract_logs_hierarchy.pl ../ > build/log_categories.rst + set +x fi -PYTHONPATH=../lib sphinx-build -M html source build ${SPHINXOPTS} 2>&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 sphinx-build -M html source build ${SPHINXOPTS} 2>&1 set +x @@ -46,7 +42,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 @@ -60,7 +57,7 @@ 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 \ + linkchecker --no-status -o csv --ignore-url='.*\.css$' --ignore-url=build/html/_modules build/html \ | grep -v '^#' \ | grep -v 'urlname;parentname;baseref;result;warningstring' echo "done." @@ -68,3 +65,5 @@ else echo "Install linkchecker to have it executed when you build the doc." fi +echo "Undocumented symbols:" +./find-missing.py \ No newline at end of file