X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/09eec4c44f8b6293cb8df12815f215e976b27360..e94c2a7fc81a82998524aa55db075be69990d4ea:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index 8fd2797e59..d335a48c0e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,11 +12,10 @@ # 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 os, subprocess # import sys # sys.path.insert(0, os.path.abspath('.')) - # -- Project information ----------------------------------------------------- project = u'SimGrid' @@ -41,7 +40,7 @@ release = u'3.21' extensions = [ 'sphinx.ext.todo', # 'sphinx.ext.coverage', - 'sphinx.ext.mathjax', +# 'sphinx.ext.mathjax', # 'sphinx.ext.ifconfig', 'breathe', 'exhale', @@ -49,10 +48,11 @@ extensions = [ todo_include_todos = True -breathe_projects = { 'simgrid': '../build/doxy/xml' } +breathe_projects = { 'simgrid': '../build/xml' } breathe_default_project = "simgrid" # Setup the exhale extension + exhale_args = { # These arguments are required "containmentFolder": "./api", @@ -61,31 +61,11 @@ exhale_args = { "doxygenStripFromPath": "..", # Suggested optional arguments "createTreeView": True, - # TIP: if using the sphinx-bootstrap-theme, you need - # "treeViewIsBootstrap": True, - "exhaleExecutesDoxygen": True, - "exhaleDoxygenStdin": """ - INPUT = ../../include/simgrid/s4u - GENERATE_XML = YES - PREDEFINED += \ - __cplusplus \ - DOXYGEN \ - XBT_PUBLIC= \ - XBT_EXPORT_NO_IMPORT= \ - XBT_IMPORT_NO_EXPORT= \ - XBT_PUBLIC_DATA=extern \ - XBT_PUBLIC= \ - XBT_INLINE= \ - XBT_ALWAYS_INLINE= \ - XBT_PRIVATE= \ - XBT_ATTRIB_NORETURN= \ - XBT_ATTRIB_UNUSED= \ - XBT_ATTRIB_DEPRECATED_v322(m)= \ - XBT_ATTRIB_DEPRECATED_v323(m)= \ - XBT_ATTRIB_DEPRECATED_v324(m)= - """ + "exhaleExecutesDoxygen": False, + # "exhaleUseDoxyfile": True, } + # For cross-ref generation primary_domain = 'cpp' @@ -115,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 @@ -153,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 } +