]> SALOME platform Git repositories - modules/smesh.git/blob - doc/docutils/conf.py.in
Salome HOME
0022098: EDF 2036 SMESH: Create groups from none conected parts of a mesh
[modules/smesh.git] / doc / docutils / conf.py.in
1 # -*- coding: iso-8859-1 -*-
2 #
3 # yacs documentation build configuration file, created by
4 # sphinx-quickstart on Fri Aug 29 09:57:25 2008.
5 #
6 # This file is execfile()d with the current directory set to its containing dir.
7 #
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).
10 #
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
13
14 import sys, os
15
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('.'))
20
21 # General configuration
22 # ---------------------
23
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']
27
28 # Uncomment the following line to build the links with Python documentation
29 # (you might need to set http_proxy environment variable for this to work)
30 #extensions += ['sphinx.ext.intersphinx']
31
32 # Intersphinx mapping to add links to modules and objects in the Python
33 # standard library documentation
34 intersphinx_mapping = {'http://docs.python.org': None}
35
36 # Add any paths that contain templates here, relative to this directory.
37 templates_path = ['_templates']
38
39 # The suffix of source filenames.
40 source_suffix = '.rst'
41
42 # The encoding of source files.
43 source_encoding = 'utf-8'
44
45 # The master toctree document.
46 master_doc = 'index'
47
48 # General information about the project.
49 project = 'SMESH python packages'
50 copyright = '2010 EDF R&D'
51
52 # The version info for the project you're documenting, acts as replacement for
53 # |version| and |release|, also used in various other places throughout the
54 # built documents.
55 #
56 # The short X.Y version.
57 version = '@VERSION@'
58 # The full version, including alpha/beta/rc tags.
59 release = '@VERSION@'
60
61 # The language for content autogenerated by Sphinx. Refer to documentation
62 # for a list of supported languages.
63 language = 'en'
64
65 # There are two options for replacing |today|: either, you set today to some
66 # non-false value, then it is used:
67 #today = ''
68 # Else, today_fmt is used as the format for a strftime call.
69 #today_fmt = '%B %d, %Y'
70
71 # List of documents that shouldn't be included in the build.
72 #unused_docs = []
73
74 # List of directories, relative to source directory, that shouldn't be searched
75 # for source files.
76 exclude_trees = ['.build','ref','images','CVS','.svn']
77
78 # The reST default role (used for this markup: `text`) to use for all documents.
79 #default_role = None
80
81 # If true, '()' will be appended to :func: etc. cross-reference text.
82 #add_function_parentheses = True
83
84 # If true, the current module name will be prepended to all description
85 # unit titles (such as .. function::).
86 #add_module_names = True
87
88 # If true, sectionauthor and moduleauthor directives will be shown in the
89 # output. They are ignored by default.
90 #show_authors = False
91
92 # The name of the Pygments (syntax highlighting) style to use.
93 pygments_style = 'sphinx'
94
95
96 # Options for HTML output
97 # -----------------------
98
99 # The theme to use for HTML and HTML Help pages.  Major themes that come with
100 # Sphinx are currently 'default' and 'sphinxdoc'.
101 html_theme = 'default'
102 #html_theme = 'nature'
103 #html_theme = 'agogo'
104 #html_theme = 'sphinxdoc'
105 #html_theme = 'omadoc'
106
107 # Add any paths that contain custom themes here, relative to this directory.
108 #html_theme_path = ['themes']
109
110 # The name for this set of Sphinx documents.  If None, it defaults to
111 # "<project> v<release> documentation".
112 #html_title = None
113
114 # A shorter title for the navigation bar.  Default is the same as html_title.
115 #html_short_title = None
116
117 # The name of an image file (relative to this directory) to place at the top
118 # of the sidebar.
119 #html_logo = None
120
121 # The name of an image file (within the static path) to use as favicon of the
122 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
123 # pixels large.
124 #html_favicon = None
125
126 # Add any paths that contain custom static files (such as style sheets) here,
127 # relative to this directory. They are copied after the builtin static files,
128 # so a file named "default.css" will overwrite the builtin "default.css".
129 #html_static_path = ['_static']
130
131 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
132 # using the given strftime format.
133 #html_last_updated_fmt = '%b %d, %Y'
134
135 # If true, SmartyPants will be used to convert quotes and dashes to
136 # typographically correct entities.
137 #html_use_smartypants = True
138
139 # Custom sidebar templates, maps document names to template names.
140 #html_sidebars = {}
141
142 # Additional templates that should be rendered to pages, maps page names to
143 # template names.
144 #html_additional_pages = {}
145
146 # If false, no module index is generated.
147 html_use_modindex = False
148
149 # If false, no index is generated.
150 #html_use_index = True
151
152 # If true, the index is split into individual pages for each letter.
153 #html_split_index = False
154
155 # If true, the reST sources are included in the HTML build as _sources/<name>.
156 html_copy_source = True
157
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 = ''
162
163 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
164 #html_file_suffix = ''
165
166 # Output file base name for HTML help builder.
167 htmlhelp_basename = 'smeshpydoc'
168
169
170 # Options for LaTeX output
171 # ------------------------
172
173 # The paper size ('letter' or 'a4').
174 latex_paper_size = 'a4'
175
176 # The font size ('10pt', '11pt' or '12pt').
177 latex_font_size = '10pt'
178
179 # Grouping the document tree into LaTeX files. List of tuples
180 # (source start file, target name, title, author, document class [howto/manual]).
181 latex_documents = [
182   ('index', 'smeshpy.tex', 'Documentation of the SMESH python packages', 'EDF R\&D', 'manual')
183 ]
184
185 # The name of an image file (relative to this directory) to place at the top of
186 # the title page.
187 latex_logo = '@srcdir@/../salome/tui/images/head.png'
188
189 # For "manual" documents, if this is true, then toplevel headings are parts,
190 # not chapters.
191 #latex_use_parts = True
192
193 # Additional stuff for the LaTeX preamble.
194 #latex_preamble = ''
195
196 # Documents to append as an appendix to all manuals.
197 #latex_appendices = []
198
199 # If false, no module index is generated.
200 latex_use_modindex = False