Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Replace non-breaking spaces.
[simgrid.git] / docs / Build.sh
index b0a94b4..6ef952a 100755 (executable)
@@ -3,22 +3,22 @@
 # Simplistic script to rebuild our documentation with sphinx-build
 
 # 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
 
-if [ "x$1" != 'xdoxy' -a -e build/xml ] ; then
+if [ "x$1" != 'xdoxy' -a -e build/xml ] ; then
   echo "Doxygen not rerun: 'doxy' was not provided as an argument"
 else
   rm -rf build/xml source/api/
   cd source; doxygen; cd ..
 fi
 
-if [ "x$1" != 'xjava' -a -e source/java ] ; then
+if [ "x$1" != 'xjava' -a -e source/java ] ; then
   echo "javasphinx not rerun: 'java' 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
+  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
@@ -38,29 +38,24 @@ 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/s4u/ -name '*.cpp'; \
+              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
 
-if [ -e /opt/simgrid ] ; then chmod -x /opt/simgrid; fi
-
-if [ -e /usr/bin/linkchecker ] ; then
-  linkchecker --no-status -o csv --ignore-url='.*\.css$' --ignore-url=public/java/org build/html \
+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."