X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/72ce071e25e2cc2626355a11d3e1088853343bfe..6c8dd229d394fdaf20facf604f7be86a5df1e368:/docs/source/conf.py?ds=sidebyside diff --git a/docs/source/conf.py b/docs/source/conf.py index 39761457ea..eee9b19573 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')) @@ -24,9 +24,10 @@ sys.path.append(os.path.abspath('_ext')) 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) + subprocess.call('pwd', shell=True) # should be in docs/source + subprocess.call('doxygen', shell=True) + subprocess.call('javasphinx-apidoc --force -o java/ ../../src/bindings/java/org/simgrid/msg', shell=True) + subprocess.call('rm java/packages.rst', shell=True) # -- Project information ----------------------------------------------------- @@ -35,9 +36,7 @@ copyright = u'2002-2019, The SimGrid Team' author = u'The SimGrid Team' # The short X.Y version -version = u'3.22.4' -# The full version, including alpha/beta/rc tags -release = u'3.23 alpha' +version = u'3.24.1' # -- General configuration --------------------------------------------------- @@ -51,39 +50,27 @@ release = u'3.23 alpha' extensions = [ 'sphinx.ext.todo', 'breathe', - # 'exhale', 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', - # 'sphinx.ext.napoleon', 'sphinx.ext.autosummary', - 'hidden_code_block', + 'sphinx_tabs.tabs', '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']