X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/324b1478707435efbb703b65e95bc1005b6fb520..84402e8e2ee2a2d0bef25fdceb0a263ed8b471f6:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index 56a3dd68e1..c309c22a2b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,31 +12,31 @@ # 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, subprocess +import os +import subprocess -# Search for our extensions too +# 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('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 --------------------------------------------------- @@ -50,36 +50,29 @@ release = u'3.21' extensions = [ 'sphinx.ext.todo', 'breathe', - 'exhale', - 'hidden_code_block', + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.autosummary', + 'sphinx_tabs.tabs', + 'javasphinx', + 'showfile', + 'autodoxy', ] todo_include_todos = True -breathe_projects = { 'simgrid': '../build/xml' } +# 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'] @@ -115,7 +108,7 @@ html_theme = 'sphinx_rtd_theme' # documentation. # html_theme_options = { - 'navigation_depth' : 4, + 'navigation_depth': 4, 'sticky_navigation': True, 'display_version': True, 'includehidden': True, @@ -144,11 +137,10 @@ htmlhelp_basename = 'SimGrid-doc' # -- Options for GitLab integration ------------------------------------------ html_context = { - "display_gitlab": True, # Integrate Gitlab + "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 } -