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 import sphinx_rtd_theme
30 extensions += ['sphinx_rtd_theme']
35 # Add any paths that contain templates here, relative to this directory.
36 templates_path = ['.templates']
38 # The suffix of source filenames.
39 source_suffix = '.rst'
41 # The master toctree document.
44 # General substitutions.
45 project = 'MeshGems-SurfOpt Plug-in'
46 copyright = '2007-2017 CEA/DEN, EDF R&D, OPEN CASCADE'
48 # The default replacements for |version| and |release|, also used in various
49 # other places throughout the built documents.
51 # The short X.Y version.
52 version = '@SALOMESMESH_VERSION@'
53 # The full version, including alpha/beta/rc tags.
54 release = '@SALOMESMESH_VERSION@'
56 # There are two options for replacing |today|: either, you set today to some
57 # non-false value, then it is used:
59 # Else, today_fmt is used as the format for a strftime call.
60 #today_fmt = '%B %d, %Y'
62 # List of documents that shouldn't be included in the build.
65 # List of directories, relative to source directories, that shouldn't be searched
69 # The reST default role (used for this markup: `text`) to use for all documents.
72 # If true, '()' will be appended to :func: etc. cross-reference text.
73 #add_function_parentheses = True
75 # If true, the current module name will be prepended to all description
76 # unit titles (such as .. function::).
77 #add_module_names = True
79 # If true, sectionauthor and moduleauthor directives will be shown in the
80 # output. They are ignored by default.
83 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style = 'sphinx'
87 # Options for HTML output
88 # -----------------------
90 # The theme to use for HTML and HTML Help pages. Major themes that come with
91 # Sphinx are currently 'default' and 'sphinxdoc'.
93 html_theme = 'sphinx_rtd_theme'
95 html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
98 themes_options['classic'] = {
99 'body_max_width':'none',
102 html_theme_options = themes_options.get(html_theme, {})
104 # The name for this set of Sphinx documents. If None, it defaults to
105 # "<project> v<release> documentation".
108 # A shorter title for the navigation bar. Default is the same as html_title.
109 #html_short_title = None
111 # The name of an image file (within the static path) to place at the top of
115 # The name of an image file (within the static path) to use as favicon of the
116 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
120 # Add any paths that contain custom static files (such as style sheets) here,
121 # relative to this directory. They are copied after the builtin static files,
122 # so a file named "default.css" will overwrite the builtin "default.css".
123 #html_static_path = ['.static']
125 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
126 # using the given strftime format.
127 #html_last_updated_fmt = '%b %d, %Y'
129 # If true, SmartyPants will be used to convert quotes and dashes to
130 # typographically correct entities.
131 #html_use_smartypants = True
133 # Custom sidebar templates, maps document names to template names.
136 # Additional templates that should be rendered to pages, maps page names to
138 #html_additional_pages = {}
140 # If false, no module index is generated.
141 #html_use_modindex = True
143 # If false, no index is generated.
144 #html_use_index = True
146 # If true, the index is split into individual pages for each letter.
147 #html_split_index = False
149 # If true, the reST sources are included in the HTML build as _sources/<name>.
150 #html_copy_source = True
152 # If true, an OpenSearch description file will be output, and all pages will
153 # contain a <link> tag referring to it. The value of this option must be the
154 # base URL from which the finished HTML is served.
155 #html_use_opensearch = ''
157 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
158 #html_file_suffix = ''
160 # Output file base name for HTML help builder.
161 htmlhelp_basename = 'YamsPlug-in doc'
164 # Options for LaTeX output
165 # ------------------------
167 # The paper size ('letter' or 'a4').
168 #latex_paper_size = 'letter'
170 # The font size ('10pt', '11pt' or '12pt').
171 #latex_font_size = '10pt'
173 # Grouping the document tree into LaTeX files. List of tuples
174 # (source start file, target name, title, author, document class [howto/manual]).
176 ('index', 'YAMSPlugIn.tex', 'Yams PlugIn Documentation',
177 'Pascale Noyret', 'manual'),
180 # The name of an image file (relative to this directory) to place at the top of
184 # For "manual" documents, if this is true, then toplevel headings are parts,
186 #latex_use_parts = False
188 # Additional stuff for the LaTeX preamble.
191 # Documents to append as an appendix to all manuals.
192 #latex_appendices = []
194 # If false, no module index is generated.
195 #latex_use_modindex = True