X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9f808ab5abb0829e8621127b3d27dea8630e117a..b9625f82f86db0674e911887addce45dca31b57f:/docs/source/conf.py

diff --git a/docs/source/conf.py b/docs/source/conf.py
index 286f452322..e06332da96 100644
--- 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,20 +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('source/_ext/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'3.23.3'
-# The full version, including alpha/beta/rc tags
-#release = u'3.23 alpha'
+version = u'3.25.1'
 
 # -- General configuration ---------------------------------------------------
 
@@ -51,39 +50,78 @@ version = u'3.23.3'
 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")
+autodoxy_requalified_identifiers =  [ # The first element will be substituted into the second one if it's starting an element or preceded by a space
+    ("Activity",       "simgrid::s4u::Activity"),
+    ("Actor",          "simgrid::s4u::Actor"),
+    ("ActorPtr",       "simgrid::s4u::ActorPtr"),
+    ("Barrier",        "simgrid::s4u::Barrier"),
+    ("BarrierPtr",     "simgrid::s4u::BarrierPtr"),
+    ("Comm",           "simgrid::s4u::Comm"),
+    ("CommPtr",        "simgrid::s4u::CommPtr"),
+    ("ConditionVariable",    "simgrid::s4u::ConditionVariable"),
+    ("ConditionVariablePtr", "simgrid::s4u::ConditionVariablePtr"),
+    ("Disk",           "simgrid::s4u::Disk"),
+    ("Exec",           "simgrid::s4u::Exec"),
+    ("ExecPtr",        "simgrid::s4u::ExecPtr"),
+    ("Host",           "simgrid::s4u::Host"),
+    ("s4u::Host",      "simgrid::s4u::Host"),
+    ("Engine",         "simgrid::s4u::Engine"),
+    ("Io",             "simgrid::s4u::Io"),
+    ("Link",           "simgrid::s4u::Link"),
+    ("Mailbox",        "simgrid::s4u::Mailbox"),
+    ("Mutex",          "simgrid::s4u::Mutex"),
+    ("s4u::Mutex",     "simgrid::s4u::Mutex"),
+    ("s4u::MutexPtr",  "simgrid::s4u::MutexPtr"),
+    ("NetZone",        "simgrid::s4u::NetZone"),
+    ("Semaphore",      "simgrid::s4u::Semaphore"),
+    ("VirtualMachine", "simgrid::s4u::VirtualMachine"),
+  ]
+
+# Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found
+nitpicky = True
+nitpick_ignore = [
+  ('cpp:identifier', 'boost'),
+  ('cpp:identifier', 'boost::intrusive_ptr<Activity>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<Actor>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<Barrier>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<Comm>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<Io>'),  
+  ('cpp:identifier', 'boost::intrusive_ptr<Mutex>'),  
+  ('cpp:identifier', 'kernel'),
+  ('cpp:identifier', 'kernel::activity'),
+  ('cpp:identifier', 'kernel::profile'),
+  ('cpp:identifier', 'kernel::resource'),
+  ('cpp:identifier', 'kernel::routing'),
+  ('cpp:identifier', 'simgrid'),
+  ('cpp:identifier', 'simgrid::s4u'),
+  ('cpp:identifier', 'this_actor'),
+  ('cpp:identifier', 's4u'),
+  ('cpp:identifier', 'size_t'),
+  ('cpp:identifier', 'uint64_t'),
+  ('cpp:identifier', 'xbt'),
+  ('cpp:identifier', 'xbt::string'),
+]
 
 # For cross-ref generation
 primary_domain = 'cpp'
 
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -130,7 +168,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.
@@ -145,7 +183,7 @@ html_theme_options = {
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'SimGrid-doc'
+htmlhelp_basename = 'simgrid-doc'
 
 # -- Options for GitLab integration ------------------------------------------
 
@@ -157,3 +195,10 @@ 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
+