# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import subprocess
+# Search for our extensions too
+import sys
+sys.path.append(os.path.abspath('_ext'))
+
+# -- Run doxygen on readthedocs.org ------------------------------------------
+
+read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
+
+if read_the_docs_build:
+ 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'2018, The SimGrid Team'
+copyright = u'2002-2020, The SimGrid Team'
author = u'The SimGrid Team'
# The short X.Y version
-version = u'3.21'
-# The full version, including alpha/beta/rc tags
-release = u'3.21'
-
+version = u'3.24.1'
# -- General configuration ---------------------------------------------------
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
-# 'sphinx.ext.coverage',
- 'sphinx.ext.mathjax',
-# 'sphinx.ext.ifconfig',
+ 'sphinx.ext.todo',
'breathe',
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.autosummary',
+ 'sphinx_tabs.tabs',
+ 'javasphinx',
+ 'showfile',
+ 'autodoxy',
]
-breathe_projects = { 'simgrid': '../doc/xml' }
+todo_include_todos = True
+
+# Setup the breath extension
+breathe_projects = {'simgrid': '../build/xml'}
breathe_default_project = "simgrid"
-
+
+# 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']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
-
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# 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,
# -- Options for GitLab integration ------------------------------------------
html_context = {
- "display_gitlab": True, # Integrate Gitlab
- "gitlab_host": "framagit.org",
+ "display_gitlab": True, # Integrate Gitlab
+ "gitlab_host": "framagit.org",
"gitlab_user": "simgrid",
"gitlab_repo": "simgrid",
- "gitlab_version": "master", # Version
- "conf_py_path": "/docs/source/", # Path in the checkout to the docs root
+ "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