X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4c1a73ad4fd3003be7637d001ed6b12c1258eb35..5937b88aaa18de687b2de15a97ee3ae0dc480f64:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index e5bcf6c9b0..dc1f498326 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,17 +40,19 @@ release = u'3.21' # 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', '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", @@ -58,12 +61,15 @@ exhale_args = { "doxygenStripFromPath": "..", # Suggested optional arguments "createTreeView": True, - # TIP: if using the sphinx-bootstrap-theme, you need - # "treeViewIsBootstrap": True, - "exhaleExecutesDoxygen": True, - "exhaleDoxygenStdin": "INPUT = ../../include" + "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'] @@ -89,7 +95,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 @@ -127,9 +132,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 } +