X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f443dae91032b57496bd1b516e3013b49e5dbf5d..8a0edc1a3b6e911b8e6b8db2cb2c94b751fae29a:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index df3339542c..227dfcf051 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -13,19 +13,31 @@ # 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('.')) + +# 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-2019, 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' +release = u'alpha 3.22' # -- General configuration --------------------------------------------------- @@ -39,11 +51,14 @@ 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 @@ -61,10 +76,8 @@ exhale_args = { "doxygenStripFromPath": "..", # Suggested optional arguments "createTreeView": True, - # TIP: if using the sphinx-bootstrap-theme, you need - # "treeViewIsBootstrap": True, "exhaleExecutesDoxygen": False, - "exhaleUseDoxyfile": True, + # "exhaleUseDoxyfile": True, } @@ -108,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,