Fixups in the SMPI tutorial

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

diff --git a/docs/source/conf.py b/docs/source/conf.py
index ffffe0152892d28a2757dcbd79642838c2d851b3..e8de0fb671433e4e9808d11f3a6ccc8c1095b65a 100644 (file)
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -15,7 +15,7 @@
 import os
 import subprocess
 
-# Search for our extensions too
+# Search for our extensions too
 import sys
 sys.path.append(os.path.abspath('_ext'))
 
@@ -24,21 +24,19 @@ sys.path.append(os.path.abspath('_ext'))
 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)
+    subprocess.call('pwd', shell=True) # should be in docs/source
+    subprocess.call('doxygen', shell=True)
+    subprocess.call('javasphinx-apidoc --force -o java/ ../../src/bindings/java/org/simgrid/msg', shell=True)
+    subprocess.call('rm java/packages.rst', shell=True)
 
 # -- Project information -----------------------------------------------------
 
 project = u'SimGrid'
-copyright = u'2002-2019, The SimGrid Team'
+copyright = u'2002-2020, The SimGrid Team'
 author = u'The SimGrid Team'
 
 # The short X.Y version
-version = u'alpha 3.23'
-# The full version, including alpha/beta/rc tags
-release = u'alpha 3.23'
-
+version = u'3.25.1'
 
 # -- General configuration ---------------------------------------------------
 
@@ -52,41 +50,29 @@ release = u'alpha 3.23'
 extensions = [
     'sphinx.ext.todo',
     'breathe',
-    #    'exhale',
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
-    #    'sphinx.ext.napoleon',
     'sphinx.ext.autosummary',
-    'hidden_code_block',
+    'sphinx_tabs.tabs',
     'javasphinx',
+    'showfile',
+    'autodoxy',
 ]
 
 todo_include_todos = True
 
+# Setup the breath extension
 breathe_projects = {'simgrid': '../build/xml'}
 breathe_default_project = "simgrid"
 
-# Setup the exhale extension
-
-exhale_args = {
-    # These arguments are required
-    "containmentFolder": "./api",
-    "rootFileName": "library_root.rst",
-    "rootFileTitle": "SimGrid Full API",
-    "doxygenStripFromPath": "..",
-    # Suggested optional arguments
-    "createTreeView": True,
-    "exhaleExecutesDoxygen": False,
-    # "exhaleUseDoxyfile":     True,
-}
-
+# Setup the autodoxy extension
+doxygen_xml = os.path.join(os.path.dirname(__file__), "..", "build", "xml")
 
 # For cross-ref generation
 primary_domain = 'cpp'
 
-
 # Add any paths that contain templates here, relative to this directory.
-# templates_path = ['_templates']
+templates_path = ['_templates']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string: ['.rst', '.md']
@@ -131,7 +117,7 @@ html_theme_options = {
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
+html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -158,3 +144,11 @@ html_context = {
     "gitlab_version": "master",  # Version
     "conf_py_path": "/docs/source/",  # Path in the checkout to the docs root
 }
+
+html_css_files = [
+    'css/custom.css',
+]
+
+# -- Other options
+
+nitpicky = True # Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found