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('pwd', shell=True) # should be in docs/source
28 subprocess.call('doxygen', shell=True)
29 subprocess.call('javasphinx-apidoc --force -o java/ ../../src/bindings/java/org/simgrid/msg', shell=True)
30 subprocess.call('rm java/packages.rst', shell=True)
32 # -- Project information -----------------------------------------------------
35 copyright = u'2002-2019, The SimGrid Team'
36 author = u'The SimGrid Team'
38 # The short X.Y version
41 # -- General configuration ---------------------------------------------------
43 # If your documentation needs a minimal Sphinx version, state it here.
45 # needs_sphinx = '1.0'
47 # Add any Sphinx extension module names here, as strings. They can be
48 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
55 'sphinx.ext.intersphinx',
56 # 'sphinx.ext.napoleon',
57 'sphinx.ext.autosummary',
62 todo_include_todos = True
64 breathe_projects = {'simgrid': '../build/xml'}
65 breathe_default_project = "simgrid"
67 # Setup the exhale extension
70 # These arguments are required
71 "containmentFolder": "./api",
72 "rootFileName": "library_root.rst",
73 "rootFileTitle": "SimGrid Full API",
74 "doxygenStripFromPath": "..",
75 # Suggested optional arguments
76 "createTreeView": True,
77 "exhaleExecutesDoxygen": False,
78 # "exhaleUseDoxyfile": True,
82 # For cross-ref generation
83 primary_domain = 'cpp'
86 # Add any paths that contain templates here, relative to this directory.
87 templates_path = ['_templates']
89 # The suffix(es) of source filenames.
90 # You can specify multiple suffix as a list of string: ['.rst', '.md']
91 source_suffix = '.rst'
93 # The master toctree document.
96 # The language for content autogenerated by Sphinx. Refer to documentation
97 # for a list of supported languages.
99 # This is also used if you do content translation via gettext catalogs.
100 # Usually you set "language" from the command line for these cases.
103 # List of patterns, relative to source directory, that match files and
104 # directories to ignore when looking for source files.
105 # This pattern also affects html_static_path and html_extra_path .
106 exclude_patterns = []
108 # The name of the Pygments (syntax highlighting) style to use.
109 pygments_style = 'sphinx'
111 # -- Options for HTML output -------------------------------------------------
113 # The theme to use for HTML and HTML Help pages. See the documentation for
114 # a list of builtin themes.
116 html_theme = 'sphinx_rtd_theme'
118 # Theme options are theme-specific and customize the look and feel of a theme
119 # further. For a list of options available for each theme, see the
122 html_theme_options = {
123 'navigation_depth': 4,
124 'sticky_navigation': True,
125 'display_version': True,
126 'includehidden': True,
129 # Add any paths that contain custom static files (such as style sheets) here,
130 # relative to this directory. They are copied after the builtin static files,
131 # so a file named "default.css" will overwrite the builtin "default.css".
132 # html_static_path = ['_static']
134 # Custom sidebar templates, must be a dictionary that maps document names
137 # The default sidebars (for documents that don't match any pattern) are
138 # defined by theme itself. Builtin themes are using these templates by
139 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
140 # 'searchbox.html']``.
142 # html_sidebars = {'**': ['localtoc.html', 'relations.html', 'searchbox.html']}
144 # -- Options for HTMLHelp output ---------------------------------------------
146 # Output file base name for HTML help builder.
147 htmlhelp_basename = 'SimGrid-doc'
149 # -- Options for GitLab integration ------------------------------------------
152 "display_gitlab": True, # Integrate Gitlab
153 "gitlab_host": "framagit.org",
154 "gitlab_user": "simgrid",
155 "gitlab_repo": "simgrid",
156 "gitlab_version": "master", # Version
157 "conf_py_path": "/docs/source/", # Path in the checkout to the docs root