X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1b966519556d1141719b7829011cdde06b9a11d6..3907e83884bae6278656e9cd2cb7ef92a8f707fb:/docs/Build.sh

diff --git a/docs/Build.sh b/docs/Build.sh
index 1815b8b243..fa133ad9a7 100755
--- a/docs/Build.sh
+++ b/docs/Build.sh
@@ -1,61 +1,69 @@
-#! /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
+
 # 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 -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" != 'xjava' -a -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
-  source/_ext/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
-    (echo -n "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}
+PYTHONPATH=../lib sphinx-build -M html source build ${SPHINXOPTS} 2>&1
 
 set +x
 
 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 '<name>' build/xml/msg_8h.xml; \
-             grep '<name>' build/xml/namespacesimgrid_1_1s4u.xml; \
-             grep '<innerclass refid=' build/xml/namespacesimgrid_1_1s4u.xml ; \
-            ) | sed 's/<[^>]*>//g' | sort )
+echo
+echo "Undocumented examples:"
+for ex in $( (cd .. ; \
+              find examples/cpp/   -name '*.cpp'; \
+              find examples/c/     -name '*.c'; \
+              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
 
-set +e
-if [ -e /opt/simgrid ] ; then chmod +x /opt/simgrid; fi
+set +e # Don't fail
+if [ -e /usr/bin/linkchecker ] ; then
+    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."
+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