1 # -*- coding: utf-8 -*-
3 # Yams PlugIn documentation build configuration file, created by
4 # sphinx-quickstart on Wed Sep 14 11:40:32 2011.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # The contents of this file are pickled, so don't put values in the namespace
9 # that aren't pickleable (module imports are okay, they're removed automatically).
11 # All configuration values have a default value; values that are commented out
12 # serve to show the default value.
16 # If your extensions are in another directory, add it here. If the directory
17 # is relative to the documentation root, use os.path.abspath to make it
18 # absolute, like shown here.
19 #sys.path.append(os.path.abspath('some/directory'))
21 # General configuration
22 # ---------------------
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']
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 master toctree document.
37 # General substitutions.
38 project = 'Plug-in blocFissure'
39 copyright = '2010-2017 EDF R&D'
41 # The default replacements for |version| and |release|, also used in various
42 # other places throughout the built documents.
44 # The short X.Y version.
45 version = '@SALOMESMESH_VERSION@'
46 # The full version, including alpha/beta/rc tags.
47 release = '@SALOMESMESH_VERSION@'
49 # There are two options for replacing |today|: either, you set today to some
50 # non-false value, then it is used:
52 # Else, today_fmt is used as the format for a strftime call.
53 today_fmt = '%B %d, %Y'
55 # List of documents that shouldn't be included in the build.
58 # List of directories, relative to source directories, that shouldn't be searched
62 # The reST default role (used for this markup: `text`) to use for all documents.
65 # If true, '()' will be appended to :func: etc. cross-reference text.
66 #add_function_parentheses = True
68 # If true, the current module name will be prepended to all description
69 # unit titles (such as .. function::).
70 #add_module_names = True
72 # If true, sectionauthor and moduleauthor directives will be shown in the
73 # output. They are ignored by default.
76 # The name of the Pygments (syntax highlighting) style to use.
77 pygments_style = 'sphinx'
80 # Options for HTML output
81 # -----------------------
83 # The style sheet to use for HTML and HTML Help pages. A file of that name
84 # must exist either in Sphinx' static/ path, or in one of the custom paths
85 # given in html_static_path.
86 #html_style = 'default'
87 html_theme = 'default'
89 # The name for this set of Sphinx documents. If None, it defaults to
90 # "<project> v<release> documentation".
93 # A shorter title for the navigation bar. Default is the same as html_title.
94 #html_short_title = None
96 # The name of an image file (within the static path) to place at the top of
100 # The name of an image file (within the static path) to use as favicon of the
101 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
105 # Add any paths that contain custom static files (such as style sheets) here,
106 # relative to this directory. They are copied after the builtin static files,
107 # so a file named "default.css" will overwrite the builtin "default.css".
108 html_static_path = ['_static']
110 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
111 # using the given strftime format.
112 html_last_updated_fmt = '%b %d, %Y'
114 # If true, SmartyPants will be used to convert quotes and dashes to
115 # typographically correct entities.
116 #html_use_smartypants = True
118 # Custom sidebar templates, maps document names to template names.
121 # Additional templates that should be rendered to pages, maps page names to
123 #html_additional_pages = {}
125 # If false, no module index is generated.
126 #html_use_modindex = True
128 # If false, no index is generated.
129 #html_use_index = True
131 # If true, the index is split into individual pages for each letter.
132 #html_split_index = False
134 # If true, the reST sources are included in the HTML build as _sources/<name>.
135 #html_copy_source = True
137 # If true, an OpenSearch description file will be output, and all pages will
138 # contain a <link> tag referring to it. The value of this option must be the
139 # base URL from which the finished HTML is served.
140 #html_use_opensearch = ''
142 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
143 #html_file_suffix = ''
145 # Output file base name for HTML help builder.
146 htmlhelp_basename = 'blocFissure_doc'
149 # Options for LaTeX output
150 # ------------------------
152 # The paper size ('letter' or 'a4').
153 #latex_paper_size = 'letter'
155 # The font size ('10pt', '11pt' or '12pt').
156 #latex_font_size = '10pt'
158 # Grouping the document tree into LaTeX files. List of tuples
159 # (source start file, target name, title, author, document class [howto/manual]).
161 ('index', 'blocFissure.tex', 'Documentation Plug-in blocFissure',
165 # The name of an image file (relative to this directory) to place at the top of
169 # For "manual" documents, if this is true, then toplevel headings are parts,
171 #latex_use_parts = False
173 # Additional stuff for the LaTeX preamble.
176 # Documents to append as an appendix to all manuals.
177 #latex_appendices = []
179 # If false, no module index is generated.
180 #latex_use_modindex = True