X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/bb8f1f0eab3f5b877d350cf6b6de33180f49efa6..2516bc5bf0760874f7ccd2b878657e6ab442649d:/docs/Build.sh

diff --git a/docs/Build.sh b/docs/Build.sh
index 03fc911c86..7da20b4b17 100755
--- a/docs/Build.sh
+++ b/docs/Build.sh
@@ -1,26 +1,58 @@
-#! /bin/sh
+#! /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
+
+# 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" != 'xjava' -a -e source/java ] ; then
+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
-  javasphinx-apidoc --force -o source/java/ ../src/bindings/java/org/simgrid/msg
-  mv source/java/packages.rst api_generated/source_java_packages.rst
-  mv source/java/org/simgrid/msg/package-index.rst api_generated/source_java_org_simgrid_msg_package-index.rst
+  
+  # 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 <<EOF
+import re
+import sys
+from javasphinx.apidoc import main
+if __name__ == '__main__':
+    sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
+    sys.exit(main())
+EOF
+
+  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
+    (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
@@ -28,30 +60,36 @@ else
   echo "javasphinx relaunched"
 fi
 
-sphinx-build -M html source build ${SPHINXOPTS}
+PYTHONPATH=../lib:source/_ext/javasphinx sphinx-build -M html source build ${SPHINXOPTS} 2>&1
 
 set +x
 
-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
+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
\ 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  --ignore-url=public/java/org 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
+