move the README.rst in examples/ as it also describes python

[simgrid.git] / docs / Build.sh

diff --git a/docs/Build.sh b/docs/Build.sh
index b9b55f2..fcfcd69 100755 (executable)
--- a/docs/Build.sh
+++ b/docs/Build.sh
@@ -2,6 +2,9 @@
 #
 # 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
+
 set -e
 
 if [ "x$1" != 'xdoxy' -a -e build/xml ] ; then
@@ -32,14 +35,24 @@ PYTHONPATH=../lib sphinx-build -M html source build ${SPHINXOPTS}
 
 set +x
 
-< 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 '<name>' build/xml/actor_8h.xml ; \
+#           grep '<name>' build/xml/barrier_8h.xml ; \
+            grep '<name>' build/xml/cond_8h.xml ; \
+            grep '<name>' build/xml/engine_8h.xml ; \
+#           grep '<name>' build/xml/host_8h.xml ; \
+#           grep '<name>' build/xml/link_8h.xml ; \
+#           grep '<name>' build/xml/mailbox_8h.xml ; \
+            grep '<name>' build/xml/msg_8h.xml ; \
+#           grep '<name>' build/xml/mutex_8h.xml ; \
+#           grep '<name>' build/xml/semaphore_8h.xml ; \
+#           grep '<name>' build/xml/vm_8h.xml ; \
+#           grep '<name>' build/xml/zone_8h.xml ; \
              grep '<innerclass refid=' build/xml/namespacesimgrid_1_1s4u.xml ; \
             ) | sed 's/<[^>]*>//g' | sort )
 do
@@ -55,3 +68,24 @@ do
     fi
   fi
 done
+
+echo "Undocumented examples:"
+for ex in `(cd .. ; find examples/s4u/ -name '*.cpp'; 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 $ex
+    fi
+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
+