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.coverage',
  43     'sphinx.ext.mathjax',
  44 #    'sphinx.ext.ifconfig',
  45     'breathe',
  46 ]
  47
  48 breathe_projects = { 'simgrid': '../doc/xml' }
  49 breathe_default_project = "simgrid"
  50
  51 # Add any paths that contain templates here, relative to this directory.
  52 # templates_path = ['_templates']
  53
  54 # The suffix(es) of source filenames.
  55 # You can specify multiple suffix as a list of string: ['.rst', '.md']
  56 source_suffix = '.rst'
  57
  58 # The master toctree document.
  59 master_doc = 'index'
  60
  61 # The language for content autogenerated by Sphinx. Refer to documentation
  62 # for a list of supported languages.
  63 #
  64 # This is also used if you do content translation via gettext catalogs.
  65 # Usually you set "language" from the command line for these cases.
  66 language = None
  67
  68 # List of patterns, relative to source directory, that match files and
  69 # directories to ignore when looking for source files.
  70 # This pattern also affects html_static_path and html_extra_path .
  71 exclude_patterns = []
  72
  73 # The name of the Pygments (syntax highlighting) style to use.
  74 pygments_style = 'sphinx'
  75
  76
  77 # -- Options for HTML output -------------------------------------------------
  78
  79 # The theme to use for HTML and HTML Help pages.  See the documentation for
  80 # a list of builtin themes.
  81 #
  82 html_theme = 'sphinx_rtd_theme'
  83
  84 # Theme options are theme-specific and customize the look and feel of a theme
  85 # further.  For a list of options available for each theme, see the
  86 # documentation.
  87 #
  88 # html_theme_options = {}
  89
  90 # Add any paths that contain custom static files (such as style sheets) here,
  91 # relative to this directory. They are copied after the builtin static files,
  92 # so a file named "default.css" will overwrite the builtin "default.css".
  93 # html_static_path = ['_static']
  94
  95 # Custom sidebar templates, must be a dictionary that maps document names
  96 # to template names.
  97 #
  98 # The default sidebars (for documents that don't match any pattern) are
  99 # defined by theme itself.  Builtin themes are using these templates by
 100 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 101 # 'searchbox.html']``.
 102 #
 103 # html_sidebars = {'**': ['localtoc.html', 'relations.html', 'searchbox.html']}
 104
 105 # -- Options for HTMLHelp output ---------------------------------------------
 106
 107 # Output file base name for HTML help builder.
 108 htmlhelp_basename = 'SimGrid-doc'
 109
 110 # -- Options for GitLab integration ------------------------------------------
 111
 112 html_context = {
 113     "display_gitlab": True, # Integrate Gitlab
 114     "gitlab_host": "framagit.org",
 115     "gitlab_user": "simgrid",
 116     "gitlab_repo": "simgrid",
 117     "gitlab_version": "master", # Version
 118     "conf_py_path": "/docs/source/", # Path in the checkout to the docs root
 119 }