X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5eeb3c843b60e9ba5e1a952ffe83df2a4d8f5fa0..324b1478707435efbb703b65e95bc1005b6fb520:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index 8fd2797e59..56a3dd68e1 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,10 +12,19 @@ # 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')) + +# -- 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) # -- Project information ----------------------------------------------------- @@ -40,19 +49,18 @@ release = u'3.21' # ones. extensions = [ 'sphinx.ext.todo', -# 'sphinx.ext.coverage', - 'sphinx.ext.mathjax', -# 'sphinx.ext.ifconfig', 'breathe', 'exhale', + 'hidden_code_block', ] 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 +69,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 +103,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,7 +114,12 @@ html_theme = 'sphinx_rtd_theme' # 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, @@ -153,9 +145,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 } +