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
  50 # highlight_language = 'c++'
  51 # todo_include_todos = False
  52
  53 # Add any paths that contain templates here, relative to this directory.
  54 templates_path = ['_templates']
  55
  56 # The suffix(es) of source filenames.
  57 # You can specify multiple suffix as a list of string:
  58 #
  59 # source_suffix = ['.rst', '.md']
  60 source_suffix = '.rst'
  61
  62 # The master toctree document.
  63 master_doc = 'index'
  64
  65 # The language for content autogenerated by Sphinx. Refer to documentation
  66 # for a list of supported languages.
  67 #
  68 # This is also used if you do content translation via gettext catalogs.
  69 # Usually you set "language" from the command line for these cases.
  70 language = None
  71
  72 # List of patterns, relative to source directory, that match files and
  73 # directories to ignore when looking for source files.
  74 # This pattern also affects html_static_path and html_extra_path .
  75 exclude_patterns = []
  76
  77 # The name of the Pygments (syntax highlighting) style to use.
  78 pygments_style = 'sphinx'
  79
  80
  81 # -- Options for HTML output -------------------------------------------------
  82
  83 # The theme to use for HTML and HTML Help pages.  See the documentation for
  84 # a list of builtin themes.
  85 #
  86 html_theme = 'sphinx_rtd_theme'
  87 # alabaster'
  88
  89 # Theme options are theme-specific and customize the look and feel of a theme
  90 # further.  For a list of options available for each theme, see the
  91 # documentation.
  92 #
  93 # html_theme_options = {}
  94
  95 # Add any paths that contain custom static files (such as style sheets) here,
  96 # relative to this directory. They are copied after the builtin static files,
  97 # so a file named "default.css" will overwrite the builtin "default.css".
  98 html_static_path = ['_static']
  99
 100 # Custom sidebar templates, must be a dictionary that maps document names
 101 # to template names.
 102 #
 103 # The default sidebars (for documents that don't match any pattern) are
 104 # defined by theme itself.  Builtin themes are using these templates by
 105 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 106 # 'searchbox.html']``.
 107 #
 108 # html_sidebars = {'**': ['localtoc.html', 'relations.html', 'searchbox.html']}
 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 }
 120
 121 # -- Options for HTMLHelp output ---------------------------------------------
 122
 123 # Output file base name for HTML help builder.
 124 htmlhelp_basename = 'SimGrid-doc'
 125
 126
 127 # -- Options for LaTeX output ------------------------------------------------
 128
 129 latex_elements = {
 130     # The paper size ('letterpaper' or 'a4paper').
 131     #
 132     # 'papersize': 'letterpaper',
 133
 134     # The font size ('10pt', '11pt' or '12pt').
 135     #
 136     # 'pointsize': '10pt',
 137
 138     # Additional stuff for the LaTeX preamble.
 139     #
 140     # 'preamble': '',
 141
 142     # Latex figure (float) alignment
 143     #
 144     # 'figure_align': 'htbp',
 145 }
 146
 147 # Grouping the document tree into LaTeX files. List of tuples
 148 # (source start file, target name, title,
 149 #  author, documentclass [howto, manual, or own class]).
 150 latex_documents = [
 151     (master_doc, 'SimGrid.tex', u'SimGrid Documentation',
 152      u'The SimGrid Team', 'manual'),
 153 ]
 154
 155
 156 # -- Options for manual page output ------------------------------------------
 157
 158 # One entry per manual page. List of tuples
 159 # (source start file, name, description, authors, manual section).
 160 man_pages = [
 161     (master_doc, 'simgrid', u'SimGrid Documentation',
 162      [author], 1)
 163 ]
 164
 165
 166 # -- Options for Texinfo output ----------------------------------------------
 167
 168 # Grouping the document tree into Texinfo files. List of tuples
 169 # (source start file, target name, title, author,
 170 #  dir menu entry, description, category)
 171 texinfo_documents = [
 172     (master_doc, 'SimGrid', u'SimGrid Documentation',
 173      author, 'SimGrid', 'One line description of project.',
 174      'Miscellaneous'),
 175 ]
 176
 177
 178 # -- Extension configuration -------------------------------------------------