# 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
+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('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.23'
# The full version, including alpha/beta/rc tags
-release = u'3.21'
+release = u'alpha 3.23'
# -- General configuration ---------------------------------------------------
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
-# 'sphinx.ext.coverage',
-# 'sphinx.ext.mathjax',
-# 'sphinx.ext.ifconfig',
+ 'sphinx.ext.todo',
'breathe',
+ # 'exhale',
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.intersphinx',
+ # 'sphinx.ext.napoleon',
+ 'sphinx.ext.autosummary',
+ 'hidden_code_block',
+ 'javasphinx',
]
-breathe_projects = { 'simgrid': '../doc/xml' }
+todo_include_todos = True
+
+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,
+}
+
+
+# For cross-ref generation
+primary_domain = 'cpp'
-# highlight_language = 'c++'
-# todo_include_todos = False
# 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:
-#
-# source_suffix = ['.rst', '.md']
+# You can specify multiple suffix as a list of string: ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
# 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
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
-# alabaster'
# Theme options are theme-specific and customize the look and feel of a 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,
# 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.
#
# html_sidebars = {'**': ['localtoc.html', 'relations.html', 'searchbox.html']}
-# -- Options for GitLab integration ------------------------------------------
-
-html_context = {
- "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
-}
-
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'SimGrid-doc'
+# -- Options for GitLab integration ------------------------------------------
-# -- Options for LaTeX output ------------------------------------------------
-
-latex_elements = {
- # The paper size ('letterpaper' or 'a4paper').
- #
- # 'papersize': 'letterpaper',
-
- # The font size ('10pt', '11pt' or '12pt').
- #
- # 'pointsize': '10pt',
-
- # Additional stuff for the LaTeX preamble.
- #
- # 'preamble': '',
-
- # Latex figure (float) alignment
- #
- # 'figure_align': 'htbp',
+html_context = {
+ "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
}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-# author, documentclass [howto, manual, or own class]).
-latex_documents = [
- (master_doc, 'SimGrid.tex', u'SimGrid Documentation',
- u'The SimGrid Team', 'manual'),
-]
-
-
-# -- Options for manual page output ------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- (master_doc, 'simgrid', u'SimGrid Documentation',
- [author], 1)
-]
-
-
-# -- Options for Texinfo output ----------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- (master_doc, 'SimGrid', u'SimGrid Documentation',
- author, 'SimGrid', 'One line description of project.',
- 'Miscellaneous'),
-]
-
-
-# -- Extension configuration -------------------------------------------------
\ No newline at end of file
