Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Introduce XBT_ATTRIB_DEPRECATED_v330.
[simgrid.git] / docs / Build.sh
index 6ef952a..6a150ef 100755 (executable)
@@ -2,19 +2,21 @@
 #
 # 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
 
-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
   rm -rf build/xml source/api/
-  cd source; doxygen; cd ..
+  (cd source; doxygen 2>&1; cd ..) | grep -v "is not documented." #   XXXXX Reduce the verbosity for now
 fi
 
-if [ "x$1" != 'xjava' -a -e source/java ] ; then
+if [ "x$1" != 'xjava' ] && [ -e source/java ] ; then
   echo "javasphinx not rerun: 'java' was not provided as an argument"
 else
   rm -rf source/java
@@ -23,7 +25,7 @@ else
   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
@@ -31,7 +33,10 @@ else
   echo "javasphinx relaunched"
 fi
 
-PYTHONPATH=../lib sphinx-build -M html source build ${SPHINXOPTS}
+PYTHONPATH=../lib sphinx-build -M html source build ${SPHINXOPTS} 2>&1 \
+  | grep -v 'WARNING: cpp:identifier reference target not found: simgrid$' \
+  | grep -v 'WARNING: cpp:identifier reference target not found: simgrid::s4u$' \
+  | grep -v 'WARNING: cpp:identifier reference target not found: boost' 
 
 set +x