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