Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid

[simgrid.git] / docs / source / conf.py

diff --git a/docs/source/conf.py b/docs/source/conf.py
index a092cde..74a7928 100644 (file)
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -13,17 +13,29 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import os, subprocess
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+
+# Search for our extensions too
+import sys
+sys.path.append(os.path.abspath('_ext'))
+
+# -- Run doxygen on readthedocs.org ------------------------------------------
+import subprocess, os
+
+read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
+
+if read_the_docs_build:
+    subprocess.call('cd source; doxygen', shell=True)
+    subprocess.call('javasphinx-apidoc --force -o source/java/ ../src/bindings/java/org/simgrid/msg', shell=True)
+    subprocess.call('rm source/java/packages.rst', shell=True)
 
 # -- Project information -----------------------------------------------------
 
 project = u'SimGrid'
-copyright = u'2018, The SimGrid Team'
+copyright = u'2002-2018, The SimGrid Team'
 author = u'The SimGrid Team'
 
 # The short X.Y version
-version = u'3.21'
+version = u'alpha 3.22'
 # The full version, including alpha/beta/rc tags
 release = u'3.21'
 
@@ -39,16 +51,15 @@ release = u'3.21'
 # ones.
 extensions = [
     'sphinx.ext.todo',
-#    'sphinx.ext.coverage',
-    'sphinx.ext.mathjax',
-#    'sphinx.ext.ifconfig',
     'breathe',
-    'exhale',
+#    'exhale',
+    'hidden_code_block',
+    'javasphinx',
 ]
 
 todo_include_todos = True
 
-breathe_projects = { 'simgrid': '../build/doxy/xml' }
+breathe_projects = { 'simgrid': '../build/xml' }
 breathe_default_project = "simgrid"
 
 # Setup the exhale extension
@@ -61,33 +72,8 @@ exhale_args = {
     "doxygenStripFromPath":  "..",
     # Suggested optional arguments
     "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,
 }
 
 
@@ -131,7 +117,12 @@ html_theme = 'sphinx_rtd_theme'
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    'navigation_depth' : 4,
+    'sticky_navigation': True,
+    'display_version': True,
+    'includehidden': True,
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,