X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/05ecee877c8dd5f568dc631744f34b4601bd68cd..8937f1426cc4c3bbe77178ce3a9cdc0687263a8e:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index 452d833e7b..74a792865d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,19 +12,30 @@ # 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) + subprocess.call('javasphinx-apidoc --force -o source/java/ ../src/bindings/java/org/simgrid/msg', shell=True) + subprocess.call('rm source/java/packages.rst', shell=True) # -- Project information ----------------------------------------------------- project = u'SimGrid' -copyright = u'2018, The SimGrid Team' +copyright = u'2002-2018, The SimGrid Team' author = u'The SimGrid Team' # The short X.Y version -version = u'3.21' +version = u'alpha 3.22' # The full version, including alpha/beta/rc tags release = u'3.21' @@ -40,19 +51,19 @@ release = u'3.21' # ones. extensions = [ 'sphinx.ext.todo', -# 'sphinx.ext.coverage', - 'sphinx.ext.mathjax', -# 'sphinx.ext.ifconfig', 'breathe', - 'exhale', +# 'exhale', + 'hidden_code_block', + 'javasphinx', ] todo_include_todos = True -breathe_projects = { 'simgrid': '../../doc/xml' } +breathe_projects = { 'simgrid': '../build/xml' } breathe_default_project = "simgrid" # Setup the exhale extension + exhale_args = { # These arguments are required "containmentFolder": "./api", @@ -61,12 +72,15 @@ exhale_args = { "doxygenStripFromPath": "..", # Suggested optional arguments "createTreeView": True, - # TIP: if using the sphinx-bootstrap-theme, you need - # "treeViewIsBootstrap": True, "exhaleExecutesDoxygen": False, - # "exhaleDoxygenStdin": "INPUT = ../../include" + # "exhaleUseDoxyfile": True, } + +# For cross-ref generation +primary_domain = 'cpp' + + # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -92,7 +106,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 @@ -104,7 +117,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, @@ -130,9 +148,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 } +