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 # Search for our extensions too
19 sys.path.append(os.path.abspath('_ext'))
21 # -- Project information -----------------------------------------------------
24 copyright = u'2018, The SimGrid Team'
25 author = u'The SimGrid Team'
27 # The short X.Y version
29 # The full version, including alpha/beta/rc tags
33 # -- General configuration ---------------------------------------------------
35 # If your documentation needs a minimal Sphinx version, state it here.
37 # needs_sphinx = '1.0'
39 # Add any Sphinx extension module names here, as strings. They can be
40 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
44 # 'sphinx.ext.coverage',
45 # 'sphinx.ext.mathjax',
46 # 'sphinx.ext.ifconfig',
52 todo_include_todos = True
54 breathe_projects = { 'simgrid': '../build/xml' }
55 breathe_default_project = "simgrid"
57 # Setup the exhale extension
60 # These arguments are required
61 "containmentFolder": "./api",
62 "rootFileName": "library_root.rst",
63 "rootFileTitle": "SimGrid Full API",
64 "doxygenStripFromPath": "..",
65 # Suggested optional arguments
66 "createTreeView": True,
67 "exhaleExecutesDoxygen": False,
68 # "exhaleUseDoxyfile": True,
72 # For cross-ref generation
73 primary_domain = 'cpp'
76 # Add any paths that contain templates here, relative to this directory.
77 # templates_path = ['_templates']
79 # The suffix(es) of source filenames.
80 # You can specify multiple suffix as a list of string: ['.rst', '.md']
81 source_suffix = '.rst'
83 # The master toctree document.
86 # The language for content autogenerated by Sphinx. Refer to documentation
87 # for a list of supported languages.
89 # This is also used if you do content translation via gettext catalogs.
90 # Usually you set "language" from the command line for these cases.
93 # List of patterns, relative to source directory, that match files and
94 # directories to ignore when looking for source files.
95 # This pattern also affects html_static_path and html_extra_path .
98 # The name of the Pygments (syntax highlighting) style to use.
99 pygments_style = 'sphinx'
101 # -- Options for HTML output -------------------------------------------------
103 # The theme to use for HTML and HTML Help pages. See the documentation for
104 # a list of builtin themes.
106 html_theme = 'sphinx_rtd_theme'
108 # Theme options are theme-specific and customize the look and feel of a theme
109 # further. For a list of options available for each theme, see the
112 # html_theme_options = {}
114 # Add any paths that contain custom static files (such as style sheets) here,
115 # relative to this directory. They are copied after the builtin static files,
116 # so a file named "default.css" will overwrite the builtin "default.css".
117 # html_static_path = ['_static']
119 # Custom sidebar templates, must be a dictionary that maps document names
122 # The default sidebars (for documents that don't match any pattern) are
123 # defined by theme itself. Builtin themes are using these templates by
124 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
125 # 'searchbox.html']``.
127 # html_sidebars = {'**': ['localtoc.html', 'relations.html', 'searchbox.html']}
129 # -- Options for HTMLHelp output ---------------------------------------------
131 # Output file base name for HTML help builder.
132 htmlhelp_basename = 'SimGrid-doc'
134 # -- Options for GitLab integration ------------------------------------------
137 "display_gitlab": True, # Integrate Gitlab
138 "gitlab_host": "framagit.org",
139 "gitlab_user": "simgrid",
140 "gitlab_repo": "simgrid",
141 "gitlab_version": "master", # Version
142 "conf_py_path": "/docs/source/", # Path in the checkout to the docs root