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)
30 # -- Project information -----------------------------------------------------
33 copyright = u'2002-2023, The SimGrid Team'
34 author = u'The SimGrid Team'
36 # The short X.Y version
39 # -- General configuration ---------------------------------------------------
41 # If your documentation needs a minimal Sphinx version, state it here.
43 # needs_sphinx = '1.0'
45 # Add any Sphinx extension module names here, as strings. They can be
46 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
52 'sphinx.ext.autosummary',
53 'sphinx.ext.intersphinx',
60 todo_include_todos = True
62 # Setup the breath extension
63 breathe_projects = {'simgrid': '../build/xml'}
64 breathe_default_project = "simgrid"
66 # Setup the copybutton extension
67 copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
68 copybutton_prompt_is_regexp = True
70 # Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found
73 ('cpp:identifier', 'boost'),
74 ('cpp:identifier', 'boost::intrusive_ptr<Activity>'),
75 ('cpp:identifier', 'boost::intrusive_ptr<Actor>'),
76 ('cpp:identifier', 'boost::intrusive_ptr<Barrier>'),
77 ('cpp:identifier', 'boost::intrusive_ptr<Comm>'),
78 ('cpp:identifier', 'boost::intrusive_ptr<ConditionVariable>'),
79 ('cpp:identifier', 'boost::intrusive_ptr<Exec>'),
80 ('cpp:identifier', 'boost::intrusive_ptr<Io>'),
81 ('cpp:identifier', 'boost::intrusive_ptr<Mutex>'),
82 ('cpp:identifier', 'boost::intrusive_ptr<Semaphore>'),
83 ('cpp:identifier', 'kernel'),
84 ('cpp:identifier', 'kernel::activity'),
85 ('cpp:identifier', 'kernel::activity::ActivityImplPtr'),
86 ('cpp:identifier', 'kernel::activity::CommImpl'),
87 ('cpp:identifier', 'kernel::activity::CommImplPtr'),
88 ('cpp:identifier', 'kernel::actor'),
89 ('cpp:identifier', 'kernel::actor::ActorCodeFactory'),
90 ('cpp:identifier', 'kernel::actor::ActorImpl'),
91 ('cpp:identifier', 'kernel::profile'),
92 ('cpp:identifier', 'kernel::profile::Profile'),
93 ('cpp:identifier', 'kernel::resource'),
94 ('cpp:identifier', 'kernel::resource::Action'),
95 ('cpp:identifier', 'kernel::resource::Action::State'),
96 ('cpp:identifier', 'kernel::resource::LinkImpl'),
97 ('cpp:identifier', 'kernel::resource::NetworkAction'),
98 ('cpp:identifier', 'kernel::resource::SplitDuplexLinkImpl'),
99 ('cpp:identifier', 'kernel::resource::StandardLinkImpl'),
100 ('cpp:identifier', 'kernel::routing'),
101 ('cpp:identifier', 'kernel::routing::NetPoint'),
102 ('cpp:identifier', 'ns3'),
103 ('cpp:identifier', 'ns3::Ptr<ns3::Node>'),
104 ('cpp:identifier', 'ns3::Node'),
105 ('cpp:identifier', 's4u'),
106 ('cpp:identifier', 's4u_Actor'),
107 ('cpp:identifier', 's4u_Barrier'),
108 ('cpp:identifier', 's4u_Comm'),
109 ('cpp:identifier', 's4u_ConditionVariable'),
110 ('cpp:identifier', 's4u_Disk'),
111 ('cpp:identifier', 's4u_Exec'),
112 ('cpp:identifier', 's4u_File'),
113 ('cpp:identifier', 's4u_Host'),
114 ('cpp:identifier', 's4u_Link'),
115 ('cpp:identifier', 's4u_Mailbox'),
116 ('cpp:identifier', 's4u_Mutex'),
117 ('cpp:identifier', 's4u_NetZone'),
118 ('cpp:identifier', 's4u_Semaphore'),
119 ('cpp:identifier', 's4u_VM'),
120 ('cpp:identifier', 's4u_VirtualMachine'),
121 ('cpp:identifier', 'simgrid'),
122 ('cpp:identifier', 'simgrid::s4u'),
123 ('cpp:identifier', 'simgrid::s4u::Activity_T<Comm>'),
124 ('cpp:identifier', 'simgrid::s4u::Activity_T<Exec>'),
125 ('cpp:identifier', 'simgrid::s4u::Activity_T<Io>'),
126 ('cpp:identifier', 'simgrid::s4u::this_actor'),
127 ('cpp:identifier', 'simgrid::xbt'),
128 ('cpp:identifier', 'size_t'),
129 ('cpp:identifier', 'ssize_t'),
130 ('cpp:identifier', 'this_actor'),
131 ('cpp:identifier', 'uint64_t'),
132 ('cpp:identifier', 'xbt'),
133 ('cpp:identifier', 'xbt_dynar_s'),
134 ('cpp:identifier', 'xbt::Extendable<Activity>'),
135 ('cpp:identifier', 'xbt::Extendable<Actor>'),
136 ('cpp:identifier', 'xbt::Extendable<Disk>'),
137 ('cpp:identifier', 'xbt::Extendable<File>'),
138 ('cpp:identifier', 'xbt::Extendable<Host>'),
139 ('cpp:identifier', 'xbt::Extendable<Link>'),
140 ('cpp:identifier', 'xbt::signal<void()>'),
141 ('cpp:identifier', 'xbt::signal<void(Actor const&)>'),
142 ('cpp:identifier', 'xbt::signal<void(Actor&)>'),
143 ('cpp:identifier', 'xbt::signal<void(Comm const&)>'),
144 ('cpp:identifier', 'xbt::signal<void(Comm const&, bool is_sender)>'),
145 ('cpp:identifier', 'xbt::signal<void(Disk const&)>'),
146 ('cpp:identifier', 'xbt::signal<void(Disk&)>'),
147 ('cpp:identifier', 'xbt::signal<void(Exec const&)>'),
148 ('cpp:identifier', 'xbt::signal<void(Host const&)>'),
149 ('cpp:identifier', 'xbt::signal<void(Host&)>'),
150 ('cpp:identifier', 'xbt::signal<void(Link const&)>'),
151 ('cpp:identifier', 'xbt::signal<void(Link&)>'),
152 ('cpp:identifier', 'xbt::signal<void(NetZone const&)>'),
153 ('cpp:identifier', 'xbt::signal<void(VirtualMachine const&)>'),
154 ('cpp:identifier', 'xbt::signal<void(const Actor&, const Host &previous_location)>'),
155 ('cpp:identifier', 'xbt::signal<void(double)>'),
156 ('cpp:identifier', 'xbt::signal<void(kernel::resource::NetworkAction&)>'),
157 ('cpp:identifier', 'xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>'),
158 ('cpp:identifier', 'xbt::signal<void(void)>'),
161 # For cross-ref generation
162 primary_domain = 'cpp'
164 # Add any paths that contain templates here, relative to this directory.
165 templates_path = ['_templates']
167 # The suffix(es) of source filenames.
168 # You can specify multiple suffix as a list of string: ['.rst', '.md']
169 source_suffix = '.rst'
171 # The master toctree document.
174 # The language for content autogenerated by Sphinx. Refer to documentation
175 # for a list of supported languages.
177 # This is also used if you do content translation via gettext catalogs.
178 # Usually you set "language" from the command line for these cases.
181 # List of patterns, relative to source directory, that match files and
182 # directories to ignore when looking for source files.
183 # This pattern also affects html_static_path and html_extra_path .
184 exclude_patterns = []
186 # The name of the Pygments (syntax highlighting) style to use.
187 pygments_style = 'sphinx'
189 # -- Options for HTML output -------------------------------------------------
191 # The theme to use for HTML and HTML Help pages. See the documentation for
192 # a list of builtin themes.
194 html_theme = 'sphinx_rtd_theme'
196 # Theme options are theme-specific and customize the look and feel of a theme
197 # further. For a list of options available for each theme, see the
200 html_theme_options = {
201 'navigation_depth': 4,
202 'sticky_navigation': True,
203 'display_version': True,
204 'includehidden': True,
207 # Add any paths that contain custom static files (such as style sheets) here,
208 # relative to this directory. They are copied after the builtin static files,
209 # so a file named "default.css" will overwrite the builtin "default.css".
210 html_static_path = ['_static']
212 # Custom sidebar templates, must be a dictionary that maps document names
215 # The default sidebars (for documents that don't match any pattern) are
216 # defined by theme itself. Builtin themes are using these templates by
217 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
218 # 'searchbox.html']``.
220 # html_sidebars = {'**': ['localtoc.html', 'relations.html', 'searchbox.html']}
222 # -- Options for HTMLHelp output ---------------------------------------------
224 # Output file base name for HTML help builder.
225 htmlhelp_basename = 'simgrid-doc'
227 # -- Options for GitLab integration ------------------------------------------
230 "display_gitlab": True, # Integrate Gitlab
231 "gitlab_host": "framagit.org",
232 "gitlab_user": "simgrid",
233 "gitlab_repo": "simgrid",
234 "gitlab_version": "master", # Version
235 "conf_py_path": "/docs/source/", # Path in the checkout to the docs root