1 # -*- coding: utf-8 -*-
3 # sat documentation build configuration file, created by
4 # sphinx-quickstart on Fri Apr 13 10:08:59 2018.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # Note that not all possible configuration values are present in this
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
17 # Append source folder to path in order to enable autodoc
18 currentPath = os.path.dirname(__file__)
19 print("sphinx on file %s" % __file__=
20 dirAutodoc = os.path.realpath(os.path.join(currentPath, '..', '..'))
21 print("autodoc on dir %s" % dirAutodoc)
22 sys.path.append(dirAutodoc)
23 sys.path.append(dirAutodoc + "/commands")
26 # https://stackoverflow.com/questions/23462494/how-to-add-a-custom-css-file-to-sphinx
27 # this needs realpath(custom), cause problem on relocated git clone,
28 # so use file link instead in _themes/alabaster: ln -s ../../../../src/custom.css custom.css
30 # custom = os.path.join('src', 'custom.css')
31 # print "setup add_stylesheet\n %s as\n %s" % (custom, os.path.realpath(custom))
32 # app.add_stylesheet(os.path.realpath(custom))
34 # If extensions (or modules to document with autodoc) are in another directory,
35 # add these directories to sys.path here. If the directory is relative to the
36 # documentation root, use os.path.abspath to make it absolute, like shown here.
37 #sys.path.insert(0, os.path.abspath('.'))
39 # -- General configuration -----------------------------------------------------
41 # If your documentation needs a minimal Sphinx version, state it here.
44 # Add any Sphinx extension module names here, as strings. They can be extensions
45 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
46 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode']
48 # do not use rst_prolog please use doc/rst_prolog.rst and '.. include:: ../rst_prolog.rst'
49 # https://github.com/sphinx-doc/sphinx/issues/2445
51 # Add any paths that contain templates here, relative to this directory.
52 templates_path = ['_templates']
54 # The suffix of source filenames.
55 source_suffix = '.rst'
57 # The encoding of source files.
58 #source_encoding = 'utf-8-sig'
60 # The master toctree document.
63 # General information about the project.
64 project = u'salomeTools'
65 copyright = u'2018, CEA'
67 # The version info for the project you're documenting, acts as replacement for
68 # |version| and |release|, also used in various other places throughout the
71 # The short X.Y version.
73 # The full version, including alpha/beta/rc tags.
76 # The language for content autogenerated by Sphinx. Refer to documentation
77 # for a list of supported languages.
80 # There are two options for replacing |today|: either, you set today to some
81 # non-false value, then it is used:
83 # Else, today_fmt is used as the format for a strftime call.
84 #today_fmt = '%B %d, %Y'
86 # List of patterns, relative to source directory, that match files and
87 # directories to ignore when looking for source files.
90 # The reST default role (used for this markup: `text`) to use for all documents.
93 # If true, '()' will be appended to :func: etc. cross-reference text.
94 #add_function_parentheses = True
96 # If true, the current module name will be prepended to all description
97 # unit titles (such as .. function::).
98 #add_module_names = True
100 # If true, sectionauthor and moduleauthor directives will be shown in the
101 # output. They are ignored by default.
102 #show_authors = False
104 # The name of the Pygments (syntax highlighting) style to use.
105 pygments_style = 'sphinx'
107 # A list of ignored prefixes for module index sorting.
108 #modindex_common_prefix = []
111 # -- Options for HTML output ---------------------------------------------------
113 # The theme to use for HTML and HTML Help pages. See the documentation for
114 # a list of builtin themes.
115 # default sphinxdoc scrolls agogo traditional nature haiku
116 html_theme = 'alabaster' #added in _theme dir
118 # Theme options are theme-specific and customize the look and feel of a theme
119 # further. For a list of options available for each theme, see the
121 html_theme_options = {
123 #'github_user': 'bitprophet',
124 #'github_repo': 'alabaster',
125 #'description': 'MYYY DESCRIPTION',
126 #'sidebar_includehidden': True,
127 #'sidebar_collapse': True,
128 #'show_powered_by': False,
129 'show_related': True,
130 'fixed_sidebar': False,
131 'page_width': '1000px',
132 'sidebar_width': '250px',
133 'font_size': '0.9em', #'1.0625em',
134 'code_font_size': '0.8em',
136 'pre_bg': '#fee', # code-block background
142 # Add any paths that contain custom themes here, relative to this directory.
143 html_theme_path = ["../_themes/alabaster", ]
145 # The name for this set of Sphinx documents. If None, it defaults to
146 # "<project> v<release> documentation".
149 # A shorter title for the navigation bar. Default is the same as html_title.
150 #html_short_title = None
152 # The name of an image file (relative to this directory) to place at the top
154 html_logo = "images/sat_v5.0.png"
156 # The name of an image file (within the static path) to use as favicon of the
157 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
161 # Add any paths that contain custom static files (such as style sheets) here,
162 # relative to this directory. They are copied after the builtin static files,
163 # so a file named "default.css" will overwrite the builtin "default.css".
164 #html_static_path = ['_static']
166 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
167 # using the given strftime format.
168 #html_last_updated_fmt = '%b %d, %Y'
170 # If true, SmartyPants will be used to convert quotes and dashes to
171 # typographically correct entities.
172 html_use_smartypants = False
174 # Custom sidebar templates, maps document names to template names.
177 # Additional templates that should be rendered to pages, maps page names to
179 #html_additional_pages = {}
181 # If false, no module index is generated.
182 #html_domain_indices = True
184 # If false, no index is generated.
185 #html_use_index = True
187 # If true, the index is split into individual pages for each letter.
188 #html_split_index = False
190 # If true, links to the reST sources are added to the pages.
191 #html_show_sourcelink = True
193 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
194 #html_show_sphinx = True
196 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
197 #html_show_copyright = True
199 # If true, an OpenSearch description file will be output, and all pages will
200 # contain a <link> tag referring to it. The value of this option must be the
201 # base URL from which the finished HTML is served.
202 #html_use_opensearch = ''
204 # This is the file name suffix for HTML files (e.g. ".xhtml").
205 #html_file_suffix = None
207 # Output file base name for HTML help builder.
208 htmlhelp_basename = 'salomeToolsdoc'
211 # -- Options for LaTeX output --------------------------------------------------
214 # The paper size ('letterpaper' or 'a4paper').
215 'papersize': 'a4paper',
217 # The font size ('10pt', '11pt' or '12pt').
220 # Additional stuff for the LaTeX preamble.
223 # http://www.sphinx-doc.org/en/master/latex.html
224 'sphinxsetup': 'verbatimwithframe=false, VerbatimColor={rgb}{.98,.94,.94}',
228 # The paper size ('letter' or 'a4').
229 #latex_paper_size = 'a4'
231 # The font size ('10pt', '11pt' or '12pt').
232 #latex_font_size = '10pt'
234 # Grouping the document tree into LaTeX files. List of tuples
235 # (source start file, target name, title, author, documentclass [howto/manual]).
237 ('index', 'salomeTools.tex', u'salomeTools Documentation',
238 u'CEA DEN/DANS/DM2S/STMF/LGLS', 'manual'),
241 # The name of an image file (relative to this directory) to place at the top of
245 # For "manual" documents, if this is true, then toplevel headings are parts,
247 #latex_use_parts = False
249 # If true, show page references after internal links.
250 latex_show_pagerefs = True
252 # If true, show URL addresses after external links.
253 latex_show_urls = 'footnote' # sphinx version 1.7 # True
255 # Additional stuff for the LaTeX preamble.
258 # Documents to append as an appendix to all manuals.
259 #latex_appendices = []
261 # If false, no module index is generated.
262 #latex_domain_indices = True
265 # -- Options for manual page output --------------------------------------------
267 # One entry per manual page. List of tuples
268 # (source start file, name, description, authors, manual section).
270 ('index', 'salometools', u'salomeTools Documentation',
271 [u'CEA DEN/DANS/DM2S/STMF/LGLS'], 1)