X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/71c2809622d2780c40083e9f3895da13953a57d8..a6e4771564d3d041955f630ce71e6123a911ce78:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index ddca903e1a..9f3d260b78 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,10 +12,11 @@ # 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, subprocess +# Search for our extensions too +import sys +sys.path.append(os.path.abspath('_ext')) # -- Project information ----------------------------------------------------- @@ -39,15 +40,39 @@ release = u'3.21' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinx.ext.todo', # 'sphinx.ext.coverage', - 'sphinx.ext.mathjax', +# 'sphinx.ext.mathjax', # 'sphinx.ext.ifconfig', 'breathe', + 'exhale', + 'hidden_code_block', ] -breathe_projects = { 'simgrid': '../doc/xml' } +todo_include_todos = True + +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, +} + + +# For cross-ref generation +primary_domain = 'cpp' + + # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -73,7 +98,6 @@ exclude_patterns = [] # 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 @@ -111,9 +135,10 @@ htmlhelp_basename = 'SimGrid-doc' html_context = { "display_gitlab": True, # Integrate Gitlab - "gitlab_host": "framagit.org", + "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 } +