From: Martin Quinson <martin.quinson@loria.fr>
Date: Fri, 24 Aug 2018 00:09:02 +0000 (+0200)
Subject: exhale: Don't run doxygen each time
X-Git-Tag: v3_21~202
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/f443dae91032b57496bd1b516e3013b49e5dbf5d?ds=sidebyside

exhale: Don't run doxygen each time
---

diff --git a/docs/Build.sh b/docs/Build.sh
index 74bcbfd3a0..e39cf57904 100755
--- a/docs/Build.sh
+++ b/docs/Build.sh
@@ -2,7 +2,15 @@
 #
 # Simplistic script to rebuild our documentation with sphinx-build
 
-rm -rf build/doxy/ source/api/
+set -e
+
+if [ "x$1" != 'xdoxy' -a -e build/xml ] ; then
+  echo "(Doxygen not rerun)"
+else
+  rm -rf build/xml source/api/
+  cd source; doxygen; cd ..
+fi
+
 sphinx-build -M html source build ${SPHINXOPTS}
 cat source/img/graphical-toc.svg \
  | perl -pe 's/(xlink:href="http)/target="_top" $1/' \
diff --git a/docs/source/Doxyfile b/docs/source/Doxyfile
new file mode 100644
index 0000000000..6f03606883
--- /dev/null
+++ b/docs/source/Doxyfile
@@ -0,0 +1,42 @@
+# What to read
+INPUT                  = ../../include/simgrid/forward.h 
+INPUT                 += ../../include/simgrid/s4u 
+INPUT                 += ../../include/simgrid/xbt
+RECURSIVE              = YES
+
+# What to produce
+OUTPUT_DIRECTORY       = ../build/
+GENERATE_XML           = YES
+GENERATE_HTML          = NO
+GENERATE_LATEX         = NO
+
+FULL_PATH_NAMES        = NO # Don't leak the path on which it was built
+XML_PROGRAMLISTING     = NO # No program listings, please
+CREATE_SUBDIRS         = NO # Mandatory for exhale
+
+# Allow for rst directives and advanced functions e.g. grid tables
+ALIASES                = "rst=\verbatim embed:rst:leading-asterisk"
+ALIASES               += "endrst=\endverbatim"
+
+# Enable preprocessing and related preprocessor necessities
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = NO
+SKIP_FUNCTION_MACROS   = NO			    
+
+PREDEFINED             += \
+    __cplusplus \
+    DOXYGEN \
+    XBT_PUBLIC= \
+    XBT_EXPORT_NO_IMPORT= \
+    XBT_IMPORT_NO_EXPORT= \
+    XBT_PUBLIC_DATA=extern \
+    XBT_PUBLIC= \
+    XBT_INLINE= \
+    XBT_ALWAYS_INLINE= \
+    XBT_PRIVATE= \
+    XBT_ATTRIB_NORETURN= \
+    XBT_ATTRIB_UNUSED= \
+    XBT_ATTRIB_DEPRECATED_v322(m)= \
+    XBT_ATTRIB_DEPRECATED_v323(m)= \
+    XBT_ATTRIB_DEPRECATED_v324(m)=
diff --git a/docs/source/conf.py b/docs/source/conf.py
index a092cde562..df3339542c 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -48,7 +48,7 @@ extensions = [
 
 todo_include_todos = True
 
-breathe_projects = { 'simgrid': '../build/doxy/xml' }
+breathe_projects = { 'simgrid': '../build/xml' }
 breathe_default_project = "simgrid"
 
 # Setup the exhale extension
@@ -63,31 +63,8 @@ exhale_args = {
     "createTreeView":        True,
     # TIP: if using the sphinx-bootstrap-theme, you need
     # "treeViewIsBootstrap": True,
-    "exhaleExecutesDoxygen": True,
-    "exhaleDoxygenStdin":    """
-    INPUT = ../../include/simgrid/s4u ../../include/simgrid/forward.h ../../include/simgrid/xbt
-    FULL_PATH_NAMES = NO # Don't leak the path on which it was built
-    GENERATE_XML           = YES
-    XML_PROGRAMLISTING     = NO # No program listings, please
-
-    PREDEFINED             += \
-        __cplusplus \
-        DOXYGEN \
-        XBT_PUBLIC= \
-        XBT_EXPORT_NO_IMPORT= \
-        XBT_IMPORT_NO_EXPORT= \
-        XBT_PUBLIC_DATA=extern \
-        XBT_PUBLIC= \
-        XBT_INLINE= \
-        XBT_ALWAYS_INLINE= \
-        XBT_PRIVATE= \
-        XBT_ATTRIB_NORETURN= \
-        XBT_ATTRIB_UNUSED= \
-        XBT_ATTRIB_DEPRECATED_v322(m)= \
-        XBT_ATTRIB_DEPRECATED_v323(m)= \
-        XBT_ATTRIB_DEPRECATED_v324(m)=
-
-    """
+    "exhaleExecutesDoxygen": False,
+    "exhaleUseDoxyfile":     True,
 }