X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f04cb933da95f9df2da6d58a72a7b1da12582f7d..7e625e5e848a284b522d69ec28cb111f1f88515b:/docs/Build.sh

diff --git a/docs/Build.sh b/docs/Build.sh
index 9bc5a2610f..e55855c7da 100755
--- a/docs/Build.sh
+++ b/docs/Build.sh
@@ -1,37 +1,67 @@
-#! /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
+
 set -e
+set -o pipefail
 
-if [ "x$1" != 'xdoxy' -a -e build/xml ] ; then
-  echo "(Doxygen not rerun)"
+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
 
-sphinx-build -M html source build ${SPHINXOPTS}
-cat source/img/graphical-toc.svg \
- | perl -pe 's/(xlink:href="http)/target="_top" $1/' \
- | perl -pe 's/(xlink:href=".*?.html)/target="_top" $1/' \
- > build/html/graphical-toc.svg
+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
 
+PYTHONPATH=../lib sphinx-build -M html source build ${SPHINXOPTS} 2>&1
 
-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` 
-do
+set +x
 
-  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
+perl -pe 's/(xlink:href="(?:http|.*\.html))/target="_top" $1/' \
+     source/img/graphical-toc.svg > build/html/graphical-toc.svg
+
+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 -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
\ No newline at end of file
+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 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
+