docs/source/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Configuration file for the Sphinx documentation builder.
   4 #
   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
   8
   9 # -- Path setup --------------------------------------------------------------
  10
  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.
  14 #
  15 import os
  16 import subprocess
  17
  18 # Search for our extensions too
  19 import sys
  20 sys.path.append(os.path.abspath('_ext'))
  21
  22 # -- Run doxygen on readthedocs.org ------------------------------------------
  23
  24 read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
  25
  26 if read_the_docs_build:
  27     subprocess.call('pwd', shell=True) # should be in docs/source
  28     subprocess.call('doxygen', shell=True)
  29
  30 # -- Project information -----------------------------------------------------
  31
  32 project = u'SimGrid'
  33 copyright = u'2002-2023, The SimGrid Team'
  34 author = u'The SimGrid Team'
  35
  36 # The short X.Y version
  37 version = u'3.32.1'
  38
  39 # -- General configuration ---------------------------------------------------
  40
  41 # If your documentation needs a minimal Sphinx version, state it here.
  42 #
  43 # needs_sphinx = '1.0'
  44
  45 # Add any Sphinx extension module names here, as strings. They can be
  46 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  47 # ones.
  48 extensions = [
  49     'sphinx.ext.todo',
  50     'breathe',
  51     'sphinx.ext.autodoc',
  52     'sphinx.ext.intersphinx',
  53     'sphinx.ext.autosummary',
  54     'sphinx_tabs.tabs',
  55     'sphinx_copybutton',
  56     'showfile',
  57 ]
  58
  59 todo_include_todos = True
  60
  61 # Setup the breath extension
  62 breathe_projects = {'simgrid': '../build/xml'}
  63 breathe_default_project = "simgrid"
  64
  65 # Setup the copybutton extension
  66 copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
  67 copybutton_prompt_is_regexp = True
  68
  69 # Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found
  70 nitpicky = True
  71 nitpick_ignore = [
  72   ('cpp:identifier', 'boost'),
  73   ('cpp:identifier', 'boost::intrusive_ptr<Activity>'),
  74   ('cpp:identifier', 'boost::intrusive_ptr<Actor>'),
  75   ('cpp:identifier', 'boost::intrusive_ptr<Barrier>'),
  76   ('cpp:identifier', 'boost::intrusive_ptr<Comm>'),
  77   ('cpp:identifier', 'boost::intrusive_ptr<ConditionVariable>'),
  78   ('cpp:identifier', 'boost::intrusive_ptr<Exec>'),
  79   ('cpp:identifier', 'boost::intrusive_ptr<Io>'),
  80   ('cpp:identifier', 'boost::intrusive_ptr<Mutex>'),
  81   ('cpp:identifier', 'boost::intrusive_ptr<Semaphore>'),
  82   ('cpp:identifier', 'kernel'),
  83   ('cpp:identifier', 'kernel::activity'),
  84   ('cpp:identifier', 'kernel::activity::ActivityImplPtr'),
  85   ('cpp:identifier', 'kernel::activity::CommImpl'),
  86   ('cpp:identifier', 'kernel::activity::CommImplPtr'),
  87   ('cpp:identifier', 'kernel::actor'),
  88   ('cpp:identifier', 'kernel::actor::ActorCodeFactory'),
  89   ('cpp:identifier', 'kernel::actor::ActorImpl'),
  90   ('cpp:identifier', 'kernel::profile'),
  91   ('cpp:identifier', 'kernel::profile::Profile'),
  92   ('cpp:identifier', 'kernel::resource'),
  93   ('cpp:identifier', 'kernel::resource::Action'),
  94   ('cpp:identifier', 'kernel::resource::Action::State'),
  95   ('cpp:identifier', 'kernel::resource::LinkImpl'),
  96   ('cpp:identifier', 'kernel::resource::NetworkAction'),
  97   ('cpp:identifier', 'kernel::resource::SplitDuplexLinkImpl'),
  98   ('cpp:identifier', 'kernel::resource::StandardLinkImpl'),
  99   ('cpp:identifier', 'kernel::routing'),
 100   ('cpp:identifier', 'kernel::routing::NetPoint'),
 101   ('cpp:identifier', 'ns3'),
 102   ('cpp:identifier', 'ns3::Ptr<ns3::Node>'),
 103   ('cpp:identifier', 'ns3::Node'),
 104   ('cpp:identifier', 's4u'),
 105   ('cpp:identifier', 's4u_Actor'),
 106   ('cpp:identifier', 's4u_Barrier'),
 107   ('cpp:identifier', 's4u_Comm'),
 108   ('cpp:identifier', 's4u_ConditionVariable'),
 109   ('cpp:identifier', 's4u_Disk'),
 110   ('cpp:identifier', 's4u_Exec'),
 111   ('cpp:identifier', 's4u_File'),
 112   ('cpp:identifier', 's4u_Host'),
 113   ('cpp:identifier', 's4u_Link'),
 114   ('cpp:identifier', 's4u_Mailbox'),
 115   ('cpp:identifier', 's4u_Mutex'),
 116   ('cpp:identifier', 's4u_NetZone'),
 117   ('cpp:identifier', 's4u_Semaphore'),
 118   ('cpp:identifier', 's4u_VM'),
 119   ('cpp:identifier', 's4u_VirtualMachine'),
 120   ('cpp:identifier', 'sg_msg_Comm'),
 121   ('cpp:identifier', 'sg_msg_Task'),
 122   ('cpp:identifier', 'simgrid'),
 123   ('cpp:identifier', 'simgrid::s4u'),
 124   ('cpp:identifier', 'simgrid::s4u::Activity_T<Comm>'),
 125   ('cpp:identifier', 'simgrid::s4u::Activity_T<Exec>'),
 126   ('cpp:identifier', 'simgrid::s4u::Activity_T<Io>'),
 127   ('cpp:identifier', 'simgrid::s4u::this_actor'),
 128   ('cpp:identifier', 'simgrid::xbt'),
 129   ('cpp:identifier', 'size_t'),
 130   ('cpp:identifier', 'ssize_t'),
 131   ('cpp:identifier', 'this_actor'),
 132   ('cpp:identifier', 'uint64_t'),
 133   ('cpp:identifier', 'xbt'),
 134   ('cpp:identifier', 'xbt_dynar_s'),
 135   ('cpp:identifier', 'xbt::Extendable<Activity>'),
 136   ('cpp:identifier', 'xbt::Extendable<Actor>'),
 137   ('cpp:identifier', 'xbt::Extendable<Disk>'),
 138   ('cpp:identifier', 'xbt::Extendable<File>'),
 139   ('cpp:identifier', 'xbt::Extendable<Host>'),
 140   ('cpp:identifier', 'xbt::Extendable<Link>'),
 141   ('cpp:identifier', 'xbt::signal<void()>'),
 142   ('cpp:identifier', 'xbt::signal<void(Actor const&)>'),
 143   ('cpp:identifier', 'xbt::signal<void(Actor&)>'),
 144   ('cpp:identifier', 'xbt::signal<void(Comm const&)>'),
 145   ('cpp:identifier', 'xbt::signal<void(Comm const&, bool is_sender)>'),
 146   ('cpp:identifier', 'xbt::signal<void(Disk const&)>'),
 147   ('cpp:identifier', 'xbt::signal<void(Disk&)>'),
 148   ('cpp:identifier', 'xbt::signal<void(Exec const&)>'),
 149   ('cpp:identifier', 'xbt::signal<void(Host const&)>'),
 150   ('cpp:identifier', 'xbt::signal<void(Host&)>'),
 151   ('cpp:identifier', 'xbt::signal<void(Link const&)>'),
 152   ('cpp:identifier', 'xbt::signal<void(Link&)>'),
 153   ('cpp:identifier', 'xbt::signal<void(NetZone const&)>'),
 154   ('cpp:identifier', 'xbt::signal<void(VirtualMachine const&)>'),
 155   ('cpp:identifier', 'xbt::signal<void(const Actor&, const Host &previous_location)>'),
 156   ('cpp:identifier', 'xbt::signal<void(double)>'),
 157   ('cpp:identifier', 'xbt::signal<void(kernel::resource::NetworkAction&)>'),
 158   ('cpp:identifier', 'xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>'),
 159   ('cpp:identifier', 'xbt::signal<void(void)>'),
 160 ]
 161
 162 # For cross-ref generation
 163 primary_domain = 'cpp'
 164
 165 # Add any paths that contain templates here, relative to this directory.
 166 templates_path = ['_templates']
 167
 168 # The suffix(es) of source filenames.
 169 # You can specify multiple suffix as a list of string: ['.rst', '.md']
 170 source_suffix = '.rst'
 171
 172 # The master toctree document.
 173 master_doc = 'index'
 174
 175 # The language for content autogenerated by Sphinx. Refer to documentation
 176 # for a list of supported languages.
 177 #
 178 # This is also used if you do content translation via gettext catalogs.
 179 # Usually you set "language" from the command line for these cases.
 180 language = None
 181
 182 # List of patterns, relative to source directory, that match files and
 183 # directories to ignore when looking for source files.
 184 # This pattern also affects html_static_path and html_extra_path .
 185 exclude_patterns = []
 186
 187 # The name of the Pygments (syntax highlighting) style to use.
 188 pygments_style = 'sphinx'
 189
 190 # -- Options for HTML output -------------------------------------------------
 191
 192 # The theme to use for HTML and HTML Help pages.  See the documentation for
 193 # a list of builtin themes.
 194 #
 195 html_theme = 'sphinx_rtd_theme'
 196
 197 # Theme options are theme-specific and customize the look and feel of a theme
 198 # further.  For a list of options available for each theme, see the
 199 # documentation.
 200 #
 201 html_theme_options = {
 202     'navigation_depth': 4,
 203     'sticky_navigation': True,
 204     'display_version': True,
 205     'includehidden': True,
 206 }
 207
 208 # Add any paths that contain custom static files (such as style sheets) here,
 209 # relative to this directory. They are copied after the builtin static files,
 210 # so a file named "default.css" will overwrite the builtin "default.css".
 211 html_static_path = ['_static']
 212
 213 # Custom sidebar templates, must be a dictionary that maps document names
 214 # to template names.
 215 #
 216 # The default sidebars (for documents that don't match any pattern) are
 217 # defined by theme itself.  Builtin themes are using these templates by
 218 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 219 # 'searchbox.html']``.
 220 #
 221 # html_sidebars = {'**': ['localtoc.html', 'relations.html', 'searchbox.html']}
 222
 223 # -- Options for HTMLHelp output ---------------------------------------------
 224
 225 # Output file base name for HTML help builder.
 226 htmlhelp_basename = 'simgrid-doc'
 227
 228 # -- Options for GitLab integration ------------------------------------------
 229
 230 html_context = {
 231     "display_gitlab": True,  # Integrate Gitlab
 232     "gitlab_host": "framagit.org",
 233     "gitlab_user": "simgrid",
 234     "gitlab_repo": "simgrid",
 235     "gitlab_version": "master",  # Version
 236     "conf_py_path": "/docs/source/",  # Path in the checkout to the docs root
 237 }
 238
 239 html_css_files = [
 240     'css/custom.css',
 241 ]
 242
 243 # -- Other options