1 # -*- coding: utf-8 -*-
3 # Configuration file for the Sphinx documentation builder.
5 # This file does only contain a selection of the most common options. For a
6 # full list see the documentation:
7 # http://www.sphinx-doc.org/en/master/config
9 # -- Path setup --------------------------------------------------------------
11 # If extensions (or modules to document with autodoc) are in another directory,
12 # add these directories to sys.path here. If the directory is relative to the
13 # documentation root, use os.path.abspath to make it absolute, like shown here.
18 # Search for our extensions too
20 sys.path.append(os.path.abspath('_ext'))
22 # -- Run doxygen on readthedocs.org ------------------------------------------
24 read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
26 if read_the_docs_build:
27 subprocess.call('cd source; doxygen', shell=True)
28 subprocess.call('javasphinx-apidoc --force -o source/java/ ../src/bindings/java/org/simgrid/msg', shell=True)
29 subprocess.call('rm source/java/packages.rst', shell=True)
31 # -- Project information -----------------------------------------------------
34 copyright = u'2002-2019, The SimGrid Team'
35 author = u'The SimGrid Team'
37 # The short X.Y version
39 # The full version, including alpha/beta/rc tags
42 # -- General configuration ---------------------------------------------------
44 # If your documentation needs a minimal Sphinx version, state it here.
46 # needs_sphinx = '1.0'
48 # Add any Sphinx extension module names here, as strings. They can be
49 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
56 'sphinx.ext.intersphinx',
57 # 'sphinx.ext.napoleon',
58 'sphinx.ext.autosummary',
63 todo_include_todos = True
65 breathe_projects = {'simgrid': '../build/xml'}
66 breathe_default_project = "simgrid"
68 # Setup the exhale extension
71 # These arguments are required
72 "containmentFolder": "./api",
73 "rootFileName": "library_root.rst",
74 "rootFileTitle": "SimGrid Full API",
75 "doxygenStripFromPath": "..",
76 # Suggested optional arguments
77 "createTreeView": True,
78 "exhaleExecutesDoxygen": False,
79 # "exhaleUseDoxyfile": True,
83 # For cross-ref generation
84 primary_domain = 'cpp'
87 # Add any paths that contain templates here, relative to this directory.
88 # templates_path = ['_templates']
90 # The suffix(es) of source filenames.
91 # You can specify multiple suffix as a list of string: ['.rst', '.md']
92 source_suffix = '.rst'
94 # The master toctree document.
97 # The language for content autogenerated by Sphinx. Refer to documentation
98 # for a list of supported languages.
100 # This is also used if you do content translation via gettext catalogs.
101 # Usually you set "language" from the command line for these cases.
104 # List of patterns, relative to source directory, that match files and
105 # directories to ignore when looking for source files.
106 # This pattern also affects html_static_path and html_extra_path .
107 exclude_patterns = []
109 # The name of the Pygments (syntax highlighting) style to use.
110 pygments_style = 'sphinx'
112 # -- Options for HTML output -------------------------------------------------
114 # The theme to use for HTML and HTML Help pages. See the documentation for
115 # a list of builtin themes.
117 html_theme = 'sphinx_rtd_theme'
119 # Theme options are theme-specific and customize the look and feel of a theme
120 # further. For a list of options available for each theme, see the
123 html_theme_options = {
124 'navigation_depth': 4,
125 'sticky_navigation': True,
126 'display_version': True,
127 'includehidden': True,
130 # Add any paths that contain custom static files (such as style sheets) here,
131 # relative to this directory. They are copied after the builtin static files,
132 # so a file named "default.css" will overwrite the builtin "default.css".
133 # html_static_path = ['_static']
135 # Custom sidebar templates, must be a dictionary that maps document names
138 # The default sidebars (for documents that don't match any pattern) are
139 # defined by theme itself. Builtin themes are using these templates by
140 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
141 # 'searchbox.html']``.
143 # html_sidebars = {'**': ['localtoc.html', 'relations.html', 'searchbox.html']}
145 # -- Options for HTMLHelp output ---------------------------------------------
147 # Output file base name for HTML help builder.
148 htmlhelp_basename = 'SimGrid-doc'
150 # -- Options for GitLab integration ------------------------------------------
153 "display_gitlab": True, # Integrate Gitlab
154 "gitlab_host": "framagit.org",
155 "gitlab_user": "simgrid",
156 "gitlab_repo": "simgrid",
157 "gitlab_version": "master", # Version
158 "conf_py_path": "/docs/source/", # Path in the checkout to the docs root