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