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'2002-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     'javasphinx',
  56 ]
  57
  58 todo_include_todos = True
  59
  60 breathe_projects = { 'simgrid': '../build/xml' }
  61 breathe_default_project = "simgrid"
  62
  63 # Setup the exhale extension
  64
  65 exhale_args = {
  66     # These arguments are required
  67     "containmentFolder":     "./api",
  68     "rootFileName":          "library_root.rst",
  69     "rootFileTitle":         "SimGrid Full API",
  70     "doxygenStripFromPath":  "..",
  71     # Suggested optional arguments
  72     "createTreeView":        True,
  73     "exhaleExecutesDoxygen": False,
  74     # "exhaleUseDoxyfile":     True,
  75 }
  76
  77
  78 # For cross-ref generation
  79 primary_domain = 'cpp'
  80
  81
  82 # Add any paths that contain templates here, relative to this directory.
  83 # templates_path = ['_templates']
  84
  85 # The suffix(es) of source filenames.
  86 # You can specify multiple suffix as a list of string: ['.rst', '.md']
  87 source_suffix = '.rst'
  88
  89 # The master toctree document.
  90 master_doc = 'index'
  91
  92 # The language for content autogenerated by Sphinx. Refer to documentation
  93 # for a list of supported languages.
  94 #
  95 # This is also used if you do content translation via gettext catalogs.
  96 # Usually you set "language" from the command line for these cases.
  97 language = None
  98
  99 # List of patterns, relative to source directory, that match files and
 100 # directories to ignore when looking for source files.
 101 # This pattern also affects html_static_path and html_extra_path .
 102 exclude_patterns = []
 103
 104 # The name of the Pygments (syntax highlighting) style to use.
 105 pygments_style = 'sphinx'
 106
 107 # -- Options for HTML output -------------------------------------------------
 108
 109 # The theme to use for HTML and HTML Help pages.  See the documentation for
 110 # a list of builtin themes.
 111 #
 112 html_theme = 'sphinx_rtd_theme'
 113
 114 # Theme options are theme-specific and customize the look and feel of a theme
 115 # further.  For a list of options available for each theme, see the
 116 # documentation.
 117 #
 118 html_theme_options = {
 119     'navigation_depth' : 4,
 120     'sticky_navigation': True,
 121     'display_version': True,
 122     'includehidden': True,
 123 }
 124
 125 # Add any paths that contain custom static files (such as style sheets) here,
 126 # relative to this directory. They are copied after the builtin static files,
 127 # so a file named "default.css" will overwrite the builtin "default.css".
 128 # html_static_path = ['_static']
 129
 130 # Custom sidebar templates, must be a dictionary that maps document names
 131 # to template names.
 132 #
 133 # The default sidebars (for documents that don't match any pattern) are
 134 # defined by theme itself.  Builtin themes are using these templates by
 135 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 136 # 'searchbox.html']``.
 137 #
 138 # html_sidebars = {'**': ['localtoc.html', 'relations.html', 'searchbox.html']}
 139
 140 # -- Options for HTMLHelp output ---------------------------------------------
 141
 142 # Output file base name for HTML help builder.
 143 htmlhelp_basename = 'SimGrid-doc'
 144
 145 # -- Options for GitLab integration ------------------------------------------
 146
 147 html_context = {
 148     "display_gitlab": True, # Integrate Gitlab
 149     "gitlab_host": "framagit.org",
 150     "gitlab_user": "simgrid",
 151     "gitlab_repo": "simgrid",
 152     "gitlab_version": "master", # Version
 153     "conf_py_path": "/docs/source/", # Path in the checkout to the docs root
 154 }
 155