1 # -*- coding: iso-8859-1 -*-
3 # yacs documentation build configuration file, created by
4 # sphinx-quickstart on Fri Aug 29 09:57:25 2008.
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; values that are commented out
12 # serve to show the default.
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('.'))
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 # 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']
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}
36 # Add any paths that contain templates here, relative to this directory.
37 templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','_templates')]
39 # The suffix of source filenames.
40 source_suffix = '.rst'
42 # The encoding of source files.
43 source_encoding = 'utf-8'
45 # The master toctree document.
48 # General information about the project.
49 project = 'MED, Manipulation de champs dans SALOME'
50 copyright = '2010-2015 CEA/DEN, EDF R&D, OPEN CASCADE, G. Boulant, A. Geay'
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
56 # The short X.Y version.
57 version = '@SALOMEMED_VERSION@'
58 # The full version, including alpha/beta/rc tags.
59 release = '@SALOMEMED_VERSION@'
61 # The language for content autogenerated by Sphinx. Refer to documentation
62 # for a list of supported languages.
65 # There are two options for replacing |today|: either, you set today to some
66 # non-false value, then it is used:
68 # Else, today_fmt is used as the format for a strftime call.
69 #today_fmt = '%B %d, %Y'
71 # List of documents that shouldn't be included in the build.
74 # List of directories, relative to source directory, that shouldn't be searched
76 exclude_trees = ['.build','ref','images','CVS','.svn']
78 # A list of glob-style patterns that should be excluded when looking for source
79 # files. They are matched against the source file names relative to the
80 # source directory, using slashes as directory separators on all platforms.
81 exclude_patterns = ['**/CVS']
83 # The reST default role (used for this markup: `text`) to use for all documents.
86 # If true, '()' will be appended to :func: etc. cross-reference text.
87 #add_function_parentheses = True
89 # If true, the current module name will be prepended to all description
90 # unit titles (such as .. function::).
91 #add_module_names = True
93 # If true, sectionauthor and moduleauthor directives will be shown in the
94 # output. They are ignored by default.
97 # The name of the Pygments (syntax highlighting) style to use.
98 pygments_style = 'sphinx'
101 # Options for HTML output
102 # -----------------------
104 # The theme to use for HTML and HTML Help pages. Major themes that come with
105 # Sphinx are currently 'default' and 'sphinxdoc'.
106 html_theme = 'classic'
107 html_theme_options = {
108 "stickysidebar": "false",
109 "rightsidebar": "false",
112 # Add any paths that contain custom themes here, relative to this directory.
113 #html_theme_path = ['themes']
115 # The name for this set of Sphinx documents. If None, it defaults to
116 # "<project> v<release> documentation".
119 # A shorter title for the navigation bar. Default is the same as html_title.
120 #html_short_title = None
122 # The name of an image file (relative to this directory) to place at the top
126 # The name of an image file (within the static path) to use as favicon of the
127 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
132 # The stylecheet file will be searched within the static path, while
133 # the layout.html file will be searched within the template path
134 # (Note that this parameter can't be used together with html_theme. Exclusive)
135 html_style = 'medop.css'
137 # Add any paths that contain custom static files (such as style sheets) here,
138 # relative to this directory. They are copied after the builtin static files,
139 # so a file named "default.css" will overwrite the builtin "default.css".
140 html_static_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','_static')]
142 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
143 # using the given strftime format.
144 #html_last_updated_fmt = '%b %d, %Y'
146 # If true, SmartyPants will be used to convert quotes and dashes to
147 # typographically correct entities.
148 #html_use_smartypants = True
150 # Custom sidebar templates, maps document names to template names.
153 # Additional templates that should be rendered to pages, maps page names to
155 #html_additional_pages = {}
157 # If false, no module index is generated.
158 html_use_modindex = False
160 # If false, no index is generated.
161 #html_use_index = True
163 # If true, the index is split into individual pages for each letter.
164 #html_split_index = False
166 # If true, the reST sources are included in the HTML build as _sources/<name>.
167 html_copy_source = True
169 # If true, an OpenSearch description file will be output, and all pages will
170 # contain a <link> tag referring to it. The value of this option must be the
171 # base URL from which the finished HTML is served.
172 #html_use_opensearch = ''
174 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
175 #html_file_suffix = ''
177 # Output file base name for HTML help builder.
178 htmlhelp_basename = 'medopdoc'
181 # Options for LaTeX output
182 # ------------------------
185 # The paper size ('letterpaper' or 'a4paper').
186 'papersize': 'a4paper',
187 # Select another font family
188 #'fontpkg':'\\usepackage{eucal}',
189 # get rid off blank pages
190 'classoptions': ',openany,oneside',
191 'babel' : '\\usepackage[english]{babel}',
192 # The font size ('10pt', '11pt' or '12pt').
193 #'pointsize': '10pt',
196 # Grouping the document tree into LaTeX files. List of tuples
197 # (source start file, target name, title, author, document class [howto/manual]).
199 ('index', 'medop-alldoc.tex', 'Documentation du module MED', 'G. Boulant', 'manual'),
200 ('medop-specifications', 'medop-specifications.tex', 'Module MED - Specifications', 'G. Boulant', 'manual'),
201 ('medop-develguide', 'medop-develguide.tex', 'Module MED - Guide de developpement', 'G. Boulant', 'manual'),
202 ('medop-userguide-gui', 'medop-userguide-gui.tex', 'Module MED - Guide d\'utilisation de l\'interface graphique', 'G. Boulant', 'howto'),
203 ('medop-userguide-api', 'medop-userguide-api.tex', 'MEDMEM library - Starter guide for users', 'G. Boulant', 'howto')
206 # The name of an image file (relative to this directory) to place at the top of
208 latex_logo = os.path.join("@CMAKE_CURRENT_SOURCE_DIR@","_static","head.png")
210 # For "manual" documents, if this is true, then toplevel headings are parts,
212 latex_use_parts = True
214 # Additional stuff for the LaTeX preamble.
217 # Documents to append as an appendix to all manuals.
218 #latex_appendices = []
220 # If false, no module index is generated.
221 latex_use_modindex = False
223 # Definition of substitute variables for rst texts
224 # ------------------------------------------------
225 # The rst_epilog can be used to define variable in conf.py and use the
226 # values of these variables in the rst text files.
227 srcdir = '@CMAKE_CURRENT_SOURCE_DIR@'
228 rst_epilog = '.. |SPHINXDOC_SRCDIR| replace:: %s' % srcdir