1 # -*- coding: utf-8 -*-
3 # HOMARD documentation build configuration file, created by
4 # sphinx-quickstart on Tue Jan 5 08:51:14 2010.
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 # If extensions (or modules to document with autodoc) are in another directory,
18 # add these directories to sys.path here. If the directory is relative to the
19 # documentation root, use os.path.abspath to make it absolute, like shown here.
20 #sys.path.append(os.path.abspath('.'))
22 # -- General configuration -----------------------------------------------------
24 # Add any Sphinx extension module names here, as strings. They can be extensions
25 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
26 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage', 'sphinx.ext.ifconfig']
28 # Add any paths that contain templates here, relative to this directory.
29 templates_path = ['_templates']
31 # The suffix of source filenames.
32 source_suffix = '.rst'
34 # The encoding of source files.
35 source_encoding = 'utf-8'
37 # The master toctree document.
40 # General information about the project.
42 copyright = u'1996, 2011, 2018, EDF R&D, G. Nicolas, A. Martin Sanchez, T. Fouquet, P. Noyret'
44 # The version info for the project you're documenting, acts as replacement for
45 # |version| and |release|, also used in various other places throughout the
48 # The short X.Y version.
49 version = '@SALOMEHOMARD_VERSION@'
50 # The full version, including alpha/beta/rc tags.
51 release = '@SALOMEHOMARD_VERSION@'
53 # The language for content autogenerated by Sphinx. Refer to documentation
54 # for a list of supported languages.
57 # There are two options for replacing |today|: either, you set today to some
58 # non-false value, then it is used:
60 # Else, today_fmt is used as the format for a strftime call.
61 #today_fmt = '%B %d, %Y'
63 # List of documents that shouldn't be included in the build.
66 # List of directories, relative to source directory, that shouldn't be searched
68 exclude_trees = ['_build','ref','images','CVS','.svn']
70 # The reST default role (used for this markup: `text`) to use for all documents.
73 # If true, '()' will be appended to :func: etc. cross-reference text.
74 #add_function_parentheses = True
76 # If true, the current module name will be prepended to all description
77 # unit titles (such as .. function::).
78 #add_module_names = True
80 # If true, sectionauthor and moduleauthor directives will be shown in the
81 # output. They are ignored by default.
84 # The name of the Pygments (syntax highlighting) style to use.
85 pygments_style = 'sphinx'
87 # A list of ignored prefixes for module index sorting.
88 #modindex_common_prefix = []
91 # -- Options for HTML output ---------------------------------------------------
93 # The theme to use for HTML and HTML Help pages. Major themes that come with
94 # Sphinx are currently 'default' and 'sphinxdoc'.
95 html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
97 # Theme options are theme-specific and customize the look and feel of a theme
98 # further. For a list of options available for each theme, see the
100 #html_theme_options = {}
102 # Add any paths that contain custom themes here, relative to this directory.
103 #html_theme_path = []
105 # The name for this set of Sphinx documents. If None, it defaults to
106 # "<project> v<release> documentation".
109 # A shorter title for the navigation bar. Default is the same as html_title.
110 #html_short_title = None
112 # The name of an image file (relative to this directory) to place at the top
115 #html_logo = "../images/HOMARD.png"
117 # The name of an image file (within the static path) to use as favicon of the
118 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
121 #html_favicon = "../images/homard_d.ico"
123 # Add any paths that contain custom static files (such as style sheets) here,
124 # relative to this directory. They are copied after the builtin static files,
125 # so a file named "default.css" will overwrite the builtin "default.css".
126 html_static_path = ['_static']
128 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
129 # using the given strftime format.
130 #html_last_updated_fmt = '%b %d, %Y'
132 # If true, SmartyPants will be used to convert quotes and dashes to
133 # typographically correct entities.
134 #html_use_smartypants = True
136 # Custom sidebar templates, maps document names to template names.
139 # Additional templates that should be rendered to pages, maps page names to
141 #html_additional_pages = {}
143 # If false, no module index is generated.
144 html_domain_indices = True
146 # If false, no index is generated.
147 html_use_index = True
149 # If true, the index is split into individual pages for each letter.
150 html_split_index = False
152 # If true, the reST sources are included in the HTML build as _sources/<name>.
153 html_copy_source = False
155 # If true, links to the reST sources are added to the pages.
156 #html_show_sourcelink = True
158 # If true, an OpenSearch description file will be output, and all pages will
159 # contain a <link> tag referring to it. The value of this option must be the
160 # base URL from which the finished HTML is served.
161 #html_use_opensearch = ''
163 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
164 #html_file_suffix = ''
166 # Output file base name for HTML help builder.
167 htmlhelp_basename = 'HOMARDdoc'
170 # -- Options for LaTeX output --------------------------------------------------
172 # Paper size option of the document class ('a4paper' or 'letterpaper'), default 'letterpaper'.
173 paper_size = 'a4paper'
175 # Point size option of the document class ('10pt', '11pt' or '12pt'), default '10pt'.
178 # Grouping the document tree into LaTeX files. List of tuples
179 # (source start file, target name, title, author, documentclass [howto/manual]).
181 ('index', 'HOMARD.tex', u'HOMARD Documentation',
182 u'G. NICOLAS, A. MARTIN SANCHEZ and T. FOUQUET', 'manual'),
185 # The name of an image file (relative to this directory) to place at the top of
188 #latex_logo = "../images/HOMARD.png"
190 # For "manual" documents, if this is true, then toplevel headings are parts,
192 #latex_use_parts = False
194 # Additional stuff for the LaTeX preamble.
197 # Documents to append as an appendix to all manuals.
198 #latex_appendices = []
200 # If false, no module index is generated.
201 latex_use_modindex = True
204 # Example configuration for intersphinx: refer to the Python standard library.
205 intersphinx_mapping = {'http://docs.python.org/': None}