Logo AND Algorithmique Numérique Distribuée

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