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 sys
  17 # sys.path.insert(0, os.path.abspath('.'))
  18
  19
  20 # -- Project information -----------------------------------------------------
  21
  22 project = u'SimGrid'
  23 copyright = u'2018, The SimGrid Team'
  24 author = u'The SimGrid Team'
  25
  26 # The short X.Y version
  27 version = u'3.21'
  28 # The full version, including alpha/beta/rc tags
  29 release = u'3.21'
  30
  31
  32 # -- General configuration ---------------------------------------------------
  33
  34 # If your documentation needs a minimal Sphinx version, state it here.
  35 #
  36 # needs_sphinx = '1.0'
  37
  38 # Add any Sphinx extension module names here, as strings. They can be
  39 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  40 # ones.
  41 extensions = [
  42     'sphinx.ext.todo',
  43 #    'sphinx.ext.coverage',
  44     'sphinx.ext.mathjax',
  45 #    'sphinx.ext.ifconfig',
  46     'breathe',
  47     'exhale',
  48 ]
  49
  50 todo_include_todos = True
  51
  52 breathe_projects = { 'simgrid': '../build/doxy/xml' }
  53 breathe_default_project = "simgrid"
  54
  55 # Setup the exhale extension
  56 exhale_args = {
  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/xbt
  69     GENERATE_XML           = YES
  70     PREDEFINED             += \
  71         __cplusplus \
  72         DOXYGEN \
  73         XBT_PUBLIC= \
  74         XBT_EXPORT_NO_IMPORT= \
  75         XBT_IMPORT_NO_EXPORT= \
  76         XBT_PUBLIC_DATA=extern \
  77         XBT_PUBLIC= \
  78         XBT_INLINE= \
  79         XBT_ALWAYS_INLINE= \
  80         XBT_PRIVATE= \
  81         XBT_ATTRIB_NORETURN= \
  82         XBT_ATTRIB_UNUSED= \
  83         XBT_ATTRIB_DEPRECATED_v322(m)= \
  84         XBT_ATTRIB_DEPRECATED_v323(m)= \
  85         XBT_ATTRIB_DEPRECATED_v324(m)=
  86
  87     """
  88 }
  89
  90 # For cross-ref generation
  91 primary_domain = 'cpp'
  92
  93
  94 # Add any paths that contain templates here, relative to this directory.
  95 # templates_path = ['_templates']
  96
  97 # The suffix(es) of source filenames.
  98 # You can specify multiple suffix as a list of string: ['.rst', '.md']
  99 source_suffix = '.rst'
 100
 101 # The master toctree document.
 102 master_doc = 'index'
 103
 104 # The language for content autogenerated by Sphinx. Refer to documentation
 105 # for a list of supported languages.
 106 #
 107 # This is also used if you do content translation via gettext catalogs.
 108 # Usually you set "language" from the command line for these cases.
 109 language = None
 110
 111 # List of patterns, relative to source directory, that match files and
 112 # directories to ignore when looking for source files.
 113 # This pattern also affects html_static_path and html_extra_path .
 114 exclude_patterns = []
 115
 116 # The name of the Pygments (syntax highlighting) style to use.
 117 pygments_style = 'sphinx'
 118
 119 # -- Options for HTML output -------------------------------------------------
 120
 121 # The theme to use for HTML and HTML Help pages.  See the documentation for
 122 # a list of builtin themes.
 123 #
 124 html_theme = 'sphinx_rtd_theme'
 125
 126 # Theme options are theme-specific and customize the look and feel of a theme
 127 # further.  For a list of options available for each theme, see the
 128 # documentation.
 129 #
 130 # html_theme_options = {}
 131
 132 # Add any paths that contain custom static files (such as style sheets) here,
 133 # relative to this directory. They are copied after the builtin static files,
 134 # so a file named "default.css" will overwrite the builtin "default.css".
 135 # html_static_path = ['_static']
 136
 137 # Custom sidebar templates, must be a dictionary that maps document names
 138 # to template names.
 139 #
 140 # The default sidebars (for documents that don't match any pattern) are
 141 # defined by theme itself.  Builtin themes are using these templates by
 142 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 143 # 'searchbox.html']``.
 144 #
 145 # html_sidebars = {'**': ['localtoc.html', 'relations.html', 'searchbox.html']}
 146
 147 # -- Options for HTMLHelp output ---------------------------------------------
 148
 149 # Output file base name for HTML help builder.
 150 htmlhelp_basename = 'SimGrid-doc'
 151
 152 # -- Options for GitLab integration ------------------------------------------
 153
 154 html_context = {
 155     "display_gitlab": True, # Integrate Gitlab
 156     "gitlab_host": "framagit.org",
 157     "gitlab_user": "simgrid",
 158     "gitlab_repo": "simgrid",
 159     "gitlab_version": "master", # Version
 160     "conf_py_path": "/docs/source/", # Path in the checkout to the docs root
 161 }