1 # -*- coding: utf-8 -*-
3 # This file is execfile()d with the current directory set to its containing dir.
5 # The contents of this file are pickled, so don't put values in the namespace
6 # that aren't pickleable (module imports are okay, they're removed automatically).
8 # All configuration values have a default; values that are commented out
9 # serve to show the default.
13 # If your extensions are in another directory, add it here. If the directory
14 # is relative to the documentation root, use os.path.abspath to make it
15 # absolute, like shown here.
16 #sys.path.append(os.path.abspath('.'))
18 # General configuration
19 # ---------------------
21 # Add any Sphinx extension module names here, as strings. They can be extensions
22 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
25 # Add any paths that contain templates here, relative to this directory.
26 templates_path = ['_templates']
28 # The suffix of source filenames.
29 source_suffix = '.rst'
31 # The encoding of source files.
32 #source_encoding = 'utf-8'
34 # The master toctree document.
37 # General information about the project.
38 project = '(name_of_application)'
39 copyright = '2010-2014 CEA/DEN, EDF R&D, OPEN CASCADE, ASTEK INDUSTRIE'
41 # The version info for the project you're documenting, acts as replacement for
42 # |version| and |release|, also used in various other places throughout the
45 # The short X.Y version.
46 version = '@SALOME[NAME_OF_APPLICATION]_MAJOR_VERSION@.@SALOME[NAME_OF_APPLICATION]_MINOR_VERSION@'
47 # The full version, including alpha/beta/rc tags.
48 release = '@SALOME[NAME_OF_APPLICATION]_VERSION@'
50 # The language for content autogenerated by Sphinx. Refer to documentation
51 # for a list of supported languages.
54 # There are two options for replacing |today|: either, you set today to some
55 # non-false value, then it is used:
57 # Else, today_fmt is used as the format for a strftime call.
58 #today_fmt = '%B %d, %Y'
60 # List of documents that shouldn't be included in the build.
63 # List of directories, relative to source directory, that shouldn't be searched
65 exclude_trees = ['.build','ref','images','CVS']
67 # A list of glob-style patterns that should be excluded when looking for source
68 # files. They are matched against the source file names relative to the
69 # source directory, using slashes as directory separators on all platforms.
70 exclude_patterns = ['**/CVS']
72 # The reST default role (used for this markup: `text`) to use for all documents.
75 # If true, '()' will be appended to :func: etc. cross-reference text.
76 #add_function_parentheses = True
78 # If true, the current module name will be prepended to all description
79 # unit titles (such as .. function::).
80 #add_module_names = True
82 # If true, sectionauthor and moduleauthor directives will be shown in the
83 # output. They are ignored by default.
86 # The name of the Pygments (syntax highlighting) style to use.
87 pygments_style = 'sphinx'
90 # Options for HTML output
91 # -----------------------
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'
97 # The name for this set of Sphinx documents. If None, it defaults to
98 # "<project> v<release> documentation".
101 # A shorter title for the navigation bar. Default is the same as html_title.
102 #html_short_title = None
104 # The name of an image file (relative to this directory) to place at the top
108 # The name of an image file (within the static path) to use as favicon of the
109 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
113 # Add any paths that contain custom static files (such as style sheets) here,
114 # relative to this directory. They are copied after the builtin static files,
115 # so a file named "default.css" will overwrite the builtin "default.css".
116 html_static_path = ['@SALOME_[NAME_OF_APPLICATION]_PROFILE_INSTALL_DOC_GUI@/_static']
118 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
119 # using the given strftime format.
120 #html_last_updated_fmt = '%b %d, %Y'
122 # If true, SmartyPants will be used to convert quotes and dashes to
123 # typographically correct entities.
124 #html_use_smartypants = True
126 # Custom sidebar templates, maps document names to template names.
129 # Additional templates that should be rendered to pages, maps page names to
131 #html_additional_pages = {}
133 # If false, no module index is generated.
134 html_use_modindex = False
136 # If false, no index is generated.
137 #html_use_index = True
139 # If true, the index is split into individual pages for each letter.
140 #html_split_index = False
142 # If true, the reST sources are included in the HTML build as _sources/<name>.
143 #html_copy_source = True
145 # If true, an OpenSearch description file will be output, and all pages will
146 # contain a <link> tag referring to it. The value of this option must be the
147 # base URL from which the finished HTML is served.
148 #html_use_opensearch = ''
150 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
151 #html_file_suffix = ''
153 # Output file base name for HTML help builder.
154 htmlhelp_basename = '(name_of_application)doc'
157 # Options for LaTeX output
158 # ------------------------
160 # The paper size ('letter' or 'a4').
161 latex_paper_size = 'a4'
163 # The font size ('10pt', '11pt' or '12pt').
164 latex_font_size = '10pt'
166 # Grouping the document tree into LaTeX files. List of tuples
167 # (source start file, target name, title, author, document class [howto/manual]).
169 ('index', '(name_of_application).tex', '<Name_of_Application> User Documentation', 'A. Ribes', 'manual')
172 # The name of an image file (relative to this directory) to place at the top of
176 # For "manual" documents, if this is true, then toplevel headings are parts,
178 #latex_use_parts = False
180 # Additional stuff for the LaTeX preamble.
183 # Documents to append as an appendix to all manuals.
184 #latex_appendices = []
186 # If false, no module index is generated.
187 latex_use_modindex = False