1 # -*- coding: utf-8 -*-
3 # TopIIVolMesh PlugIn documentation build configuration file
9 # If your extensions are in another directory, add it here. If the directory
10 # is relative to the documentation root, use os.path.abspath to make it
11 # absolute, like shown here.
12 #sys.path.append(os.path.abspath('some/directory'))
14 # General configuration
15 # ---------------------
17 # Add any Sphinx extension module names here, as strings. They can be extensions
18 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
19 extensions = ['sphinx.ext.autodoc']
21 import sphinx_rtd_theme
22 extensions += ['sphinx_rtd_theme']
27 # Add any paths that contain templates here, relative to this directory.
28 templates_path = ['.templates']
30 # The suffix of source filenames.
31 source_suffix = '.rst'
33 # The master toctree document.
36 # General substitutions.
37 project = 'topIIvol Plug-in'
38 copyright = '2007-2022 CEA'
40 # The default replacements for |version| and |release|, also used in various
41 # other places throughout the built documents.
43 # The short X.Y version.
44 version = '@SALOMESMESH_VERSION@'
45 # The full version, including alpha/beta/rc tags.
46 release = '@SALOMESMESH_VERSION@'
48 # There are two options for replacing |today|: either, you set today to some
49 # non-false value, then it is used:
51 # Else, today_fmt is used as the format for a strftime call.
52 #today_fmt = '%B %d, %Y'
54 # List of documents that shouldn't be included in the build.
57 # List of directories, relative to source directories, that shouldn't be searched
61 # The reST default role (used for this markup: `text`) to use for all documents.
64 # If true, '()' will be appended to :func: etc. cross-reference text.
65 #add_function_parentheses = True
67 # If true, the current module name will be prepended to all description
68 # unit titles (such as .. function::).
69 #add_module_names = True
71 # If true, sectionauthor and moduleauthor directives will be shown in the
72 # output. They are ignored by default.
75 # The name of the Pygments (syntax highlighting) style to use.
76 pygments_style = 'sphinx'
79 # Options for HTML output
80 # -----------------------
82 # The theme to use for HTML and HTML Help pages. Major themes that come with
83 # Sphinx are currently 'default' and 'sphinxdoc'.
85 html_theme = 'sphinx_rtd_theme'
87 html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic'
90 themes_options['classic'] = {
91 'body_max_width':'none',
94 html_theme_options = themes_options.get(html_theme, {})
96 # The name for this set of Sphinx documents. If None, it defaults to
97 # "<project> v<release> documentation".
100 # A shorter title for the navigation bar. Default is the same as html_title.
101 #html_short_title = None
103 # The name of an image file (within the static path) to place at the top of
107 # The name of an image file (within the static path) to use as favicon of the
108 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
112 # Add any paths that contain custom static files (such as style sheets) here,
113 # relative to this directory. They are copied after the builtin static files,
114 # so a file named "default.css" will overwrite the builtin "default.css".
115 #html_static_path = ['.static']
117 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
118 # using the given strftime format.
119 #html_last_updated_fmt = '%b %d, %Y'
121 # If true, SmartyPants will be used to convert quotes and dashes to
122 # typographically correct entities.
123 #html_use_smartypants = True
125 # Custom sidebar templates, maps document names to template names.
128 # Additional templates that should be rendered to pages, maps page names to
130 #html_additional_pages = {}
132 # If false, no module index is generated.
133 #html_use_modindex = True
135 # If false, no index is generated.
136 #html_use_index = True
138 # If true, the index is split into individual pages for each letter.
139 #html_split_index = False
141 # If true, the reST sources are included in the HTML build as _sources/<name>.
142 #html_copy_source = True
144 # If true, an OpenSearch description file will be output, and all pages will
145 # contain a <link> tag referring to it. The value of this option must be the
146 # base URL from which the finished HTML is served.
147 #html_use_opensearch = ''
149 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
150 #html_file_suffix = ''
152 # Output file base name for HTML help builder.
153 htmlhelp_basename = 'TopIIVolMeshPlug-in doc'
156 # Options for LaTeX output
157 # ------------------------
159 # The paper size ('letter' or 'a4').
160 #latex_paper_size = 'letter'
162 # The font size ('10pt', '11pt' or '12pt').
163 #latex_font_size = '10pt'
165 # Grouping the document tree into LaTeX files. List of tuples
166 # (source start file, target name, title, author, document class [howto/manual]).
168 ('index', 'TopIIVolMeshPlugIn.tex', 'TopIIVolMesh PlugIn Documentation',
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 = True