X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/67ebba4175baedb772c36affafe342fed64154ee..d3c1a287e32a22288af6e167f4f3ad8aa7a2e86c:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index d335a48c0e..dce6685743 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,21 +12,33 @@ # 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, subprocess -# import sys -# sys.path.insert(0, os.path.abspath('.')) +import os +import subprocess + +# Search for our extensions too +import sys +sys.path.append(os.path.abspath('_ext')) + +# -- Run doxygen on readthedocs.org ------------------------------------------ + +read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' + +if read_the_docs_build: + subprocess.call('pwd', shell=True) # should be in docs/source + subprocess.call('doxygen', shell=True) + subprocess.call('_ext/javasphinx-apidoc --force -o java/ ../../src/bindings/java/org/simgrid/msg', shell=True) + subprocess.call('rm java/packages.rst', shell=True) # -- Project information ----------------------------------------------------- project = u'SimGrid' -copyright = u'2018, The SimGrid Team' +copyright = u'2002-2019, The SimGrid Team' author = u'The SimGrid Team' # The short X.Y version -version = u'3.21' +version = u'3.23.3' # The full version, including alpha/beta/rc tags -release = u'3.21' - +#release = u'3.23 alpha' # -- General configuration --------------------------------------------------- @@ -39,28 +51,31 @@ release = u'3.21' # ones. extensions = [ 'sphinx.ext.todo', -# 'sphinx.ext.coverage', -# 'sphinx.ext.mathjax', -# 'sphinx.ext.ifconfig', 'breathe', - 'exhale', + # 'exhale', + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + # 'sphinx.ext.napoleon', + 'sphinx.ext.autosummary', + 'hidden_code_block', + 'javasphinx', ] todo_include_todos = True -breathe_projects = { 'simgrid': '../build/xml' } +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": "..", + "containmentFolder": "./api", + "rootFileName": "library_root.rst", + "rootFileTitle": "SimGrid Full API", + "doxygenStripFromPath": "..", # Suggested optional arguments - "createTreeView": True, + "createTreeView": True, "exhaleExecutesDoxygen": False, # "exhaleUseDoxyfile": True, } @@ -71,7 +86,7 @@ primary_domain = 'cpp' # Add any paths that contain templates here, relative to this directory. -# templates_path = ['_templates'] +templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: ['.rst', '.md'] @@ -106,7 +121,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, @@ -131,11 +151,10 @@ htmlhelp_basename = 'SimGrid-doc' # -- Options for GitLab integration ------------------------------------------ html_context = { - "display_gitlab": True, # Integrate Gitlab + "display_gitlab": True, # Integrate Gitlab "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 + "gitlab_version": "master", # Version + "conf_py_path": "/docs/source/", # Path in the checkout to the docs root } -