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.
17 # If your extensions are in another directory, add it here. If the directory
18 # is relative to the documentation root, use os.path.abspath to make it
19 # absolute, like shown here.
20 #sys.path.append(os.path.abspath('some/directory'))
22 # General configuration
23 # ---------------------
25 # Add any Sphinx extension module names here, as strings. They can be extensions
26 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
27 extensions = ['sphinx.ext.autodoc']
29 # Add any paths that contain templates here, relative to this directory.
30 templates_path = ['.templates']
32 # The suffix of source filenames.
33 source_suffix = '.rst'
35 # The master toctree document.
38 # General substitutions.
39 project = 'MeshGems-SurfOpt Plug-in'
40 copyright = '2007-2017 CEA/DEN, EDF R&D, OPEN CASCADE'
42 # The default replacements for |version| and |release|, also used in various
43 # other places throughout the built documents.
45 # The short X.Y version.
46 version = '@SALOMESMESH_VERSION@'
47 # The full version, including alpha/beta/rc tags.
48 release = '@SALOMESMESH_VERSION@'
50 # There are two options for replacing |today|: either, you set today to some
51 # non-false value, then it is used:
53 # Else, today_fmt is used as the format for a strftime call.
54 #today_fmt = '%B %d, %Y'
56 # List of documents that shouldn't be included in the build.
59 # List of directories, relative to source directories, that shouldn't be searched
63 # The reST default role (used for this markup: `text`) to use for all documents.
66 # If true, '()' will be appended to :func: etc. cross-reference text.
67 #add_function_parentheses = True
69 # If true, the current module name will be prepended to all description
70 # unit titles (such as .. function::).
71 #add_module_names = True
73 # If true, sectionauthor and moduleauthor directives will be shown in the
74 # output. They are ignored by default.
77 # The name of the Pygments (syntax highlighting) style to use.
78 pygments_style = 'sphinx'
81 # Options for HTML output
82 # -----------------------
84 # The theme to use for HTML and HTML Help pages. Major themes that come with
85 # Sphinx are currently 'default' and 'sphinxdoc'.
86 html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
88 themes_options['classic'] = {
89 'body_max_width':'none',
92 html_theme_options = themes_options.get(html_theme, {})
94 # The name for this set of Sphinx documents. If None, it defaults to
95 # "<project> v<release> documentation".
98 # A shorter title for the navigation bar. Default is the same as html_title.
99 #html_short_title = None
101 # The name of an image file (within the static path) to place at the top of
105 # The name of an image file (within the static path) to use as favicon of the
106 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
110 # Add any paths that contain custom static files (such as style sheets) here,
111 # relative to this directory. They are copied after the builtin static files,
112 # so a file named "default.css" will overwrite the builtin "default.css".
113 #html_static_path = ['.static']
115 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
116 # using the given strftime format.
117 #html_last_updated_fmt = '%b %d, %Y'
119 # If true, SmartyPants will be used to convert quotes and dashes to
120 # typographically correct entities.
121 #html_use_smartypants = True
123 # Custom sidebar templates, maps document names to template names.
126 # Additional templates that should be rendered to pages, maps page names to
128 #html_additional_pages = {}
130 # If false, no module index is generated.
131 #html_use_modindex = True
133 # If false, no index is generated.
134 #html_use_index = True
136 # If true, the index is split into individual pages for each letter.
137 #html_split_index = False
139 # If true, the reST sources are included in the HTML build as _sources/<name>.
140 #html_copy_source = True
142 # If true, an OpenSearch description file will be output, and all pages will
143 # contain a <link> tag referring to it. The value of this option must be the
144 # base URL from which the finished HTML is served.
145 #html_use_opensearch = ''
147 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
148 #html_file_suffix = ''
150 # Output file base name for HTML help builder.
151 htmlhelp_basename = 'YamsPlug-in doc'
154 # Options for LaTeX output
155 # ------------------------
157 # The paper size ('letter' or 'a4').
158 #latex_paper_size = 'letter'
160 # The font size ('10pt', '11pt' or '12pt').
161 #latex_font_size = '10pt'
163 # Grouping the document tree into LaTeX files. List of tuples
164 # (source start file, target name, title, author, document class [howto/manual]).
166 ('index', 'YAMSPlugIn.tex', 'Yams PlugIn Documentation',
167 'Pascale Noyret', 'manual'),
170 # The name of an image file (relative to this directory) to place at the top of
174 # For "manual" documents, if this is true, then toplevel headings are parts,
176 #latex_use_parts = False
178 # Additional stuff for the LaTeX preamble.
181 # Documents to append as an appendix to all manuals.
182 #latex_appendices = []
184 # If false, no module index is generated.
185 #latex_use_modindex = True