X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7d486d1d3b2c9c2c5d286e1d49c27453a382ce9e..094f8c02076206ad96ec3bbad1af2d387534a002:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index eb4687f619..0ca9461b26 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -15,7 +15,7 @@ import os import subprocess -# Search for our extensions too +# Search for our extensions too import sys sys.path.append(os.path.abspath('_ext')) @@ -32,11 +32,11 @@ if read_the_docs_build: # -- Project information ----------------------------------------------------- project = u'SimGrid' -copyright = u'2002-2019, The SimGrid Team' +copyright = u'2002-2020, The SimGrid Team' author = u'The SimGrid Team' # The short X.Y version -version = u'3.24.1' +version = u'3.25.1' # -- General configuration --------------------------------------------------- @@ -50,41 +50,27 @@ version = u'3.24.1' extensions = [ 'sphinx.ext.todo', 'breathe', - # 'exhale', 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', - # 'sphinx.ext.napoleon', 'sphinx.ext.autosummary', 'sphinx_tabs.tabs', - 'sphinxcontrib.contentui', 'javasphinx', 'showfile', + 'autodoxy', ] todo_include_todos = True +# 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'] @@ -131,7 +117,7 @@ html_theme_options = { # 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, # so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = ['_static'] +html_static_path = ['_static'] # Custom sidebar templates, must be a dictionary that maps document names # to template names. @@ -146,7 +132,7 @@ html_theme_options = { # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = 'SimGrid-doc' +htmlhelp_basename = 'simgrid-doc' # -- Options for GitLab integration ------------------------------------------ @@ -158,3 +144,11 @@ html_context = { "gitlab_version": "master", # Version "conf_py_path": "/docs/source/", # Path in the checkout to the docs root } + +html_css_files = [ + 'css/custom.css', +] + +# -- Other options + +nitpicky = True # Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found