1 # Copyright (C) 2009-2013 EDF R&D
3 # This library is free software; you can redistribute it and/or
4 # modify it under the terms of the GNU Lesser General Public
5 # License as published by the Free Software Foundation; either
6 # version 2.1 of the License.
8 # This library is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 # Lesser General Public License for more details.
13 # You should have received a copy of the GNU Lesser General Public
14 # License along with this library; if not, write to the Free Software
15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 from string import Template
23 from compat import Template,set
26 include $$(top_srcdir)/adm_local/make_common_starter.am
28 salomedoc_DATA=html/index.html
29 salomeres_DATA = ${others}
35 SOURCEDIR = $$(srcdir)
36 SPHINXBUILD = sphinx-build
37 PAPEROPT_a4 = -D latex_paper_size=a4
38 ALLSPHINXOPTS = -d doctrees $$(PAPEROPT_a4) $$(SPHINXOPTS) $$(SOURCEDIR)
41 mkdir -p html doctrees
42 $$(SPHINXBUILD) -b html $$(ALLSPHINXOPTS) html
44 @echo "Build finished. The HTML pages are in html."
47 $$(INSTALL) -d $$(DESTDIR)$$(salomedocdir)
48 cp -rf html/* $$(DESTDIR)$$(salomedocdir) ;
51 chmod -R +w $$(DESTDIR)$$(salomedocdir)
52 rm -rf $$(DESTDIR)$$(salomedocdir)/*
55 -rm -rf html latex doctrees
56 if test -d "html"; then rm -rf html ; fi
59 docmakefile=Template(docmakefile)
61 docconf="""# -*- coding: utf-8 -*-
63 # ${module} documentation build configuration file, created by
64 # sphinx-quickstart on Sun Sep 19 16:20:14 2010.
66 # This file is execfile()d with the current directory set to its containing dir.
68 # Note that not all possible configuration values are present in this
71 # All configuration values have a default; values that are commented out
72 # serve to show the default.
76 # If extensions (or modules to document with autodoc) are in another directory,
77 # add these directories to sys.path here. If the directory is relative to the
78 # documentation root, use os.path.abspath to make it absolute, like shown here.
79 #sys.path.insert(0, os.path.abspath('.'))
81 # -- General configuration -----------------------------------------------------
83 # If your documentation needs a minimal Sphinx version, state it here.
86 # Add any Sphinx extension module names here, as strings. They can be extensions
87 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
90 # Add any paths that contain templates here, relative to this directory.
91 templates_path = ['_templates']
93 # The suffix of source filenames.
94 source_suffix = '.rst'
96 # The encoding of source files.
97 #source_encoding = 'utf-8-sig'
99 # The master toctree document.
102 # General information about the project.
103 project = u'${module}'
106 # The version info for the project you're documenting, acts as replacement for
107 # |version| and |release|, also used in various other places throughout the
110 # The short X.Y version.
112 # The full version, including alpha/beta/rc tags.
115 # The language for content autogenerated by Sphinx. Refer to documentation
116 # for a list of supported languages.
119 # There are two options for replacing |today|: either, you set today to some
120 # non-false value, then it is used:
122 # Else, today_fmt is used as the format for a strftime call.
123 #today_fmt = '%B %d, %Y'
125 # List of patterns, relative to source directory, that match files and
126 # directories to ignore when looking for source files.
127 exclude_patterns = ['_build']
129 # The reST default role (used for this markup: `text`) to use for all documents.
132 # If true, '()' will be appended to :func: etc. cross-reference text.
133 #add_function_parentheses = True
135 # If true, the current module name will be prepended to all description
136 # unit titles (such as .. function::).
137 #add_module_names = True
139 # If true, sectionauthor and moduleauthor directives will be shown in the
140 # output. They are ignored by default.
141 #show_authors = False
143 # The name of the Pygments (syntax highlighting) style to use.
144 pygments_style = 'sphinx'
146 # A list of ignored prefixes for module index sorting.
147 #modindex_common_prefix = []
150 # -- Options for HTML output ---------------------------------------------------
152 # The theme to use for HTML and HTML Help pages. See the documentation for
153 # a list of builtin themes.
154 html_theme = 'default'
156 # Theme options are theme-specific and customize the look and feel of a theme
157 # further. For a list of options available for each theme, see the
159 #html_theme_options = {}
161 # Add any paths that contain custom themes here, relative to this directory.
162 #html_theme_path = []
164 # The name for this set of Sphinx documents. If None, it defaults to
165 # "<project> v<release> documentation".
168 # A shorter title for the navigation bar. Default is the same as html_title.
169 #html_short_title = None
171 # The name of an image file (relative to this directory) to place at the top
175 # The name of an image file (within the static path) to use as favicon of the
176 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
180 # Add any paths that contain custom static files (such as style sheets) here,
181 # relative to this directory. They are copied after the builtin static files,
182 # so a file named "default.css" will overwrite the builtin "default.css".
183 html_static_path = ['_static']
185 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
186 # using the given strftime format.
187 #html_last_updated_fmt = '%b %d, %Y'
189 # If true, SmartyPants will be used to convert quotes and dashes to
190 # typographically correct entities.
191 #html_use_smartypants = True
193 # Custom sidebar templates, maps document names to template names.
196 # Additional templates that should be rendered to pages, maps page names to
198 #html_additional_pages = {}
200 # If false, no module index is generated.
201 #html_domain_indices = True
203 # If false, no index is generated.
204 #html_use_index = True
206 # If true, the index is split into individual pages for each letter.
207 #html_split_index = False
209 # If true, links to the reST sources are added to the pages.
210 #html_show_sourcelink = True
212 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
213 #html_show_sphinx = True
215 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
216 #html_show_copyright = True
218 # If true, an OpenSearch description file will be output, and all pages will
219 # contain a <link> tag referring to it. The value of this option must be the
220 # base URL from which the finished HTML is served.
221 #html_use_opensearch = ''
223 # This is the file name suffix for HTML files (e.g. ".xhtml").
224 #html_file_suffix = None
226 # Output file base name for HTML help builder.
227 htmlhelp_basename = '${module}doc'
230 # -- Options for LaTeX output --------------------------------------------------
232 # The paper size ('letter' or 'a4').
233 #latex_paper_size = 'letter'
235 # The font size ('10pt', '11pt' or '12pt').
236 #latex_font_size = '10pt'
238 # Grouping the document tree into LaTeX files. List of tuples
239 # (source start file, target name, title, author, documentclass [howto/manual]).
241 ('index', '${module}.tex', u'${module} Documentation',
245 # The name of an image file (relative to this directory) to place at the top of
249 # For "manual" documents, if this is true, then toplevel headings are parts,
251 #latex_use_parts = False
253 # If true, show page references after internal links.
254 #latex_show_pagerefs = False
256 # If true, show URL addresses after external links.
257 #latex_show_urls = False
259 # Additional stuff for the LaTeX preamble.
262 # Documents to append as an appendix to all manuals.
263 #latex_appendices = []
265 # If false, no module index is generated.
266 #latex_domain_indices = True
269 # -- Options for manual page output --------------------------------------------
271 # One entry per manual page. List of tuples
272 # (source start file, name, description, authors, manual section).
274 ('index', '${module}', u'${module} Documentation',
279 docconf=Template(docconf)
283 <section name="${module}">
284 <parameter name="name" value="${module}"/>
286 <section name="resources">
287 <parameter name="${module}" value="$${${module}_ROOT_DIR}/share/salome/resources/${lmodule}"/>
291 docsalomeapp=Template(docsalomeapp)