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