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('pwd', shell=True) # should be in docs/source
  28     subprocess.call('doxygen', shell=True)
  29     subprocess.call('javasphinx-apidoc --force -o java/ ../../src/bindings/java/org/simgrid/msg', shell=True)
  30     subprocess.call('rm java/packages.rst', shell=True)
  31
  32 # -- Project information -----------------------------------------------------
  33
  34 project = u'SimGrid'
  35 copyright = u'2002-2019, The SimGrid Team'
  36 author = u'The SimGrid Team'
  37
  38 # The short X.Y version
  39 version = u'3.24.1'
  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     'sphinx.ext.autodoc',
  54     'sphinx.ext.intersphinx',
  55     'sphinx.ext.autosummary',
  56     'sphinx_tabs.tabs',
  57     'javasphinx',
  58     'showfile',
  59     'autodoxy',
  60 ]
  61
  62 todo_include_todos = True
  63
  64 # Setup the breath extension
  65 breathe_projects = {'simgrid': '../build/xml'}
  66 breathe_default_project = "simgrid"
  67
  68 # Setup the autodoxy extension
  69 doxygen_xml = os.path.join(os.path.dirname(__file__), "..", "build", "xml")
  70
  71 # For cross-ref generation
  72 primary_domain = 'cpp'
  73
  74 # Add any paths that contain templates here, relative to this directory.
  75 templates_path = ['_templates']
  76
  77 # The suffix(es) of source filenames.
  78 # You can specify multiple suffix as a list of string: ['.rst', '.md']
  79 source_suffix = '.rst'
  80
  81 # The master toctree document.
  82 master_doc = 'index'
  83
  84 # The language for content autogenerated by Sphinx. Refer to documentation
  85 # for a list of supported languages.
  86 #
  87 # This is also used if you do content translation via gettext catalogs.
  88 # Usually you set "language" from the command line for these cases.
  89 language = None
  90
  91 # List of patterns, relative to source directory, that match files and
  92 # directories to ignore when looking for source files.
  93 # This pattern also affects html_static_path and html_extra_path .
  94 exclude_patterns = []
  95
  96 # The name of the Pygments (syntax highlighting) style to use.
  97 pygments_style = 'sphinx'
  98
  99 # -- Options for HTML output -------------------------------------------------
 100
 101 # The theme to use for HTML and HTML Help pages.  See the documentation for
 102 # a list of builtin themes.
 103 #
 104 html_theme = 'sphinx_rtd_theme'
 105
 106 # Theme options are theme-specific and customize the look and feel of a theme
 107 # further.  For a list of options available for each theme, see the
 108 # documentation.
 109 #
 110 html_theme_options = {
 111     'navigation_depth': 4,
 112     'sticky_navigation': True,
 113     'display_version': True,
 114     'includehidden': True,
 115 }
 116
 117 # Add any paths that contain custom static files (such as style sheets) here,
 118 # relative to this directory. They are copied after the builtin static files,
 119 # so a file named "default.css" will overwrite the builtin "default.css".
 120 # html_static_path = ['_static']
 121
 122 # Custom sidebar templates, must be a dictionary that maps document names
 123 # to template names.
 124 #
 125 # The default sidebars (for documents that don't match any pattern) are
 126 # defined by theme itself.  Builtin themes are using these templates by
 127 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 128 # 'searchbox.html']``.
 129 #
 130 # html_sidebars = {'**': ['localtoc.html', 'relations.html', 'searchbox.html']}
 131
 132 # -- Options for HTMLHelp output ---------------------------------------------
 133
 134 # Output file base name for HTML help builder.
 135 htmlhelp_basename = 'SimGrid-doc'
 136
 137 # -- Options for GitLab integration ------------------------------------------
 138
 139 html_context = {
 140     "display_gitlab": True,  # Integrate Gitlab
 141     "gitlab_host": "framagit.org",
 142     "gitlab_user": "simgrid",
 143     "gitlab_repo": "simgrid",
 144     "gitlab_version": "master",  # Version
 145     "conf_py_path": "/docs/source/",  # Path in the checkout to the docs root
 146 }