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-2021, 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
54 'sphinx.ext.intersphinx',
55 'sphinx.ext.autosummary',
61 todo_include_todos = True
63 # Setup the breath extension
64 breathe_projects = {'simgrid': '../build/xml'}
65 breathe_default_project = "simgrid"
67 # Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found
70 ('cpp:identifier', 'boost'),
71 ('cpp:identifier', 'boost::intrusive_ptr<Activity>'),
72 ('cpp:identifier', 'boost::intrusive_ptr<Actor>'),
73 ('cpp:identifier', 'boost::intrusive_ptr<Barrier>'),
74 ('cpp:identifier', 'boost::intrusive_ptr<ConditionVariable>'),
75 ('cpp:identifier', 'boost::intrusive_ptr<Comm>'),
76 ('cpp:identifier', 'boost::intrusive_ptr<Exec>'),
77 ('cpp:identifier', 'boost::intrusive_ptr<Io>'),
78 ('cpp:identifier', 'boost::intrusive_ptr<Mutex>'),
79 ('cpp:identifier', 'boost::intrusive_ptr<Semaphore>'),
80 ('cpp:identifier', 'kernel'),
81 ('cpp:identifier', 'kernel::activity'),
82 ('cpp:identifier', 'kernel::profile'),
83 ('cpp:identifier', 'kernel::resource'),
84 ('cpp:identifier', 'kernel::routing'),
85 ('cpp:identifier', 'sg_msg_Comm'),
86 ('cpp:identifier', 'sg_msg_Task'),
87 ('cpp:identifier', 'simgrid'),
88 ('cpp:identifier', 'simgrid::s4u'),
89 ('cpp:identifier', 'simgrid::s4u::this_actor'),
90 ('cpp:identifier', 'simgrid::s4u::Activity_T<Comm>'),
91 ('cpp:identifier', 'simgrid::s4u::Activity_T<Io>'),
92 ('cpp:identifier', 'simgrid::xbt'),
93 ('cpp:identifier', 'this_actor'),
94 ('cpp:identifier', 's4u'),
95 ('cpp:identifier', 's4u_Actor'),
96 ('cpp:identifier', 's4u_Barrier'),
97 ('cpp:identifier', 's4u_Comm'),
98 ('cpp:identifier', 's4u_ConditionVariable'),
99 ('cpp:identifier', 's4u_Exec'),
100 ('cpp:identifier', 's4u_Host'),
101 ('cpp:identifier', 's4u_NetZone'),
102 ('cpp:identifier', 's4u_Mailbox'),
103 ('cpp:identifier', 's4u_Mutex'),
104 ('cpp:identifier', 's4u_Link'),
105 ('cpp:identifier', 's4u_Semaphore'),
106 ('cpp:identifier', 's4u_VirtualMachine'),
107 ('cpp:identifier', 's4u_VM'),
108 ('cpp:identifier', 'size_t'),
109 ('cpp:identifier', 'uint64_t'),
110 ('cpp:identifier', 'xbt'),
111 ('cpp:identifier', 'xbt::string'),
114 # For cross-ref generation
115 primary_domain = 'cpp'
117 # Add any paths that contain templates here, relative to this directory.
118 templates_path = ['_templates']
120 # The suffix(es) of source filenames.
121 # You can specify multiple suffix as a list of string: ['.rst', '.md']
122 source_suffix = '.rst'
124 # The master toctree document.
127 # The language for content autogenerated by Sphinx. Refer to documentation
128 # for a list of supported languages.
130 # This is also used if you do content translation via gettext catalogs.
131 # Usually you set "language" from the command line for these cases.
134 # List of patterns, relative to source directory, that match files and
135 # directories to ignore when looking for source files.
136 # This pattern also affects html_static_path and html_extra_path .
137 exclude_patterns = []
139 # The name of the Pygments (syntax highlighting) style to use.
140 pygments_style = 'sphinx'
142 # -- Options for HTML output -------------------------------------------------
144 # The theme to use for HTML and HTML Help pages. See the documentation for
145 # a list of builtin themes.
147 html_theme = 'sphinx_rtd_theme'
149 # Theme options are theme-specific and customize the look and feel of a theme
150 # further. For a list of options available for each theme, see the
153 html_theme_options = {
154 'navigation_depth': 4,
155 'sticky_navigation': True,
156 'display_version': True,
157 'includehidden': True,
160 # Add any paths that contain custom static files (such as style sheets) here,
161 # relative to this directory. They are copied after the builtin static files,
162 # so a file named "default.css" will overwrite the builtin "default.css".
163 html_static_path = ['_static']
165 # Custom sidebar templates, must be a dictionary that maps document names
168 # The default sidebars (for documents that don't match any pattern) are
169 # defined by theme itself. Builtin themes are using these templates by
170 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
171 # 'searchbox.html']``.
173 # html_sidebars = {'**': ['localtoc.html', 'relations.html', 'searchbox.html']}
175 # -- Options for HTMLHelp output ---------------------------------------------
177 # Output file base name for HTML help builder.
178 htmlhelp_basename = 'simgrid-doc'
180 # -- Options for GitLab integration ------------------------------------------
183 "display_gitlab": True, # Integrate Gitlab
184 "gitlab_host": "framagit.org",
185 "gitlab_user": "simgrid",
186 "gitlab_repo": "simgrid",
187 "gitlab_version": "master", # Version
188 "conf_py_path": "/docs/source/", # Path in the checkout to the docs root