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.
17 # sys.path.insert(0, os.path.abspath('.'))
19 # -- Project information -----------------------------------------------------
22 copyright = u'2018, The SimGrid Team'
23 author = u'The SimGrid Team'
25 # The short X.Y version
27 # The full version, including alpha/beta/rc tags
31 # -- General configuration ---------------------------------------------------
33 # If your documentation needs a minimal Sphinx version, state it here.
35 # needs_sphinx = '1.0'
37 # Add any Sphinx extension module names here, as strings. They can be
38 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
42 # 'sphinx.ext.coverage',
44 # 'sphinx.ext.ifconfig',
49 todo_include_todos = True
51 breathe_projects = { 'simgrid': '../build/doxy/xml' }
52 breathe_default_project = "simgrid"
54 # Setup the exhale extension
57 # These arguments are required
58 "containmentFolder": "./api",
59 "rootFileName": "library_root.rst",
60 "rootFileTitle": "SimGrid Full API",
61 "doxygenStripFromPath": "..",
62 # Suggested optional arguments
63 "createTreeView": True,
64 # TIP: if using the sphinx-bootstrap-theme, you need
65 # "treeViewIsBootstrap": True,
66 "exhaleExecutesDoxygen": True,
67 "exhaleDoxygenStdin": """
68 INPUT = ../../include/simgrid/s4u ../../include/simgrid/forward.h ../../include/simgrid/xbt
69 FULL_PATH_NAMES = NO # Don't leak the path on which it was built
71 XML_PROGRAMLISTING = NO # No program listings, please
77 XBT_EXPORT_NO_IMPORT= \
78 XBT_IMPORT_NO_EXPORT= \
79 XBT_PUBLIC_DATA=extern \
84 XBT_ATTRIB_NORETURN= \
86 XBT_ATTRIB_DEPRECATED_v322(m)= \
87 XBT_ATTRIB_DEPRECATED_v323(m)= \
88 XBT_ATTRIB_DEPRECATED_v324(m)=
94 # For cross-ref generation
95 primary_domain = 'cpp'
98 # Add any paths that contain templates here, relative to this directory.
99 # templates_path = ['_templates']
101 # The suffix(es) of source filenames.
102 # You can specify multiple suffix as a list of string: ['.rst', '.md']
103 source_suffix = '.rst'
105 # The master toctree document.
108 # The language for content autogenerated by Sphinx. Refer to documentation
109 # for a list of supported languages.
111 # This is also used if you do content translation via gettext catalogs.
112 # Usually you set "language" from the command line for these cases.
115 # List of patterns, relative to source directory, that match files and
116 # directories to ignore when looking for source files.
117 # This pattern also affects html_static_path and html_extra_path .
118 exclude_patterns = []
120 # The name of the Pygments (syntax highlighting) style to use.
121 pygments_style = 'sphinx'
123 # -- Options for HTML output -------------------------------------------------
125 # The theme to use for HTML and HTML Help pages. See the documentation for
126 # a list of builtin themes.
128 html_theme = 'sphinx_rtd_theme'
130 # Theme options are theme-specific and customize the look and feel of a theme
131 # further. For a list of options available for each theme, see the
134 # html_theme_options = {}
136 # Add any paths that contain custom static files (such as style sheets) here,
137 # relative to this directory. They are copied after the builtin static files,
138 # so a file named "default.css" will overwrite the builtin "default.css".
139 # html_static_path = ['_static']
141 # Custom sidebar templates, must be a dictionary that maps document names
144 # The default sidebars (for documents that don't match any pattern) are
145 # defined by theme itself. Builtin themes are using these templates by
146 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
147 # 'searchbox.html']``.
149 # html_sidebars = {'**': ['localtoc.html', 'relations.html', 'searchbox.html']}
151 # -- Options for HTMLHelp output ---------------------------------------------
153 # Output file base name for HTML help builder.
154 htmlhelp_basename = 'SimGrid-doc'
156 # -- Options for GitLab integration ------------------------------------------
159 "display_gitlab": True, # Integrate Gitlab
160 "gitlab_host": "framagit.org",
161 "gitlab_user": "simgrid",
162 "gitlab_repo": "simgrid",
163 "gitlab_version": "master", # Version
164 "conf_py_path": "/docs/source/", # Path in the checkout to the docs root