import os
import subprocess
-# Search for our extensions too
+# Search for our extensions too
import sys
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'3.22.4'
-# The full version, including alpha/beta/rc tags
-release = u'3.23 alpha'
+version = u'3.24.1'
# -- General configuration ---------------------------------------------------
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']
"gitlab_version": "master", # Version
"conf_py_path": "/docs/source/", # Path in the checkout to the docs root
}
+
+# -- Other options
+
+nitpicky = True # Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found