diff options
Diffstat (limited to 'contrib/tos/conf.py')
-rw-r--r-- | contrib/tos/conf.py | 282 |
1 files changed, 282 insertions, 0 deletions
diff --git a/contrib/tos/conf.py b/contrib/tos/conf.py new file mode 100644 index 0000000..2939255 --- /dev/null +++ b/contrib/tos/conf.py | |||
@@ -0,0 +1,282 @@ | |||
1 | """ | ||
2 | This file is part of GNU TALER. | ||
3 | Copyright (C) 2014-2020 Taler Systems SA | ||
4 | |||
5 | TALER is free software; you can redistribute it and/or modify it under the | ||
6 | terms of the GNU Lesser General Public License as published by the Free Software | ||
7 | Foundation; either version 2.1, or (at your option) any later version. | ||
8 | |||
9 | TALER is distributed in the hope that it will be useful, but WITHOUT ANY | ||
10 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR | ||
11 | A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. | ||
12 | |||
13 | You should have received a copy of the GNU Lesser General Public License along with | ||
14 | TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> | ||
15 | |||
16 | @author Florian Dold | ||
17 | @author Benedikt Muller | ||
18 | @author Sree Harsha Totakura | ||
19 | @author Marcello Stanisci | ||
20 | """ | ||
21 | # -*- coding: utf-8 -*- | ||
22 | # | ||
23 | # neuro documentation build configuration file, created by | ||
24 | # sphinx-quickstart on Sat May 31 13:11:06 2014. | ||
25 | # | ||
26 | # This file is execfile()d with the current directory set to its | ||
27 | # containing dir. | ||
28 | # | ||
29 | # Note that not all possible configuration values are present in this | ||
30 | # autogenerated file. | ||
31 | # | ||
32 | # All configuration values have a default; values that are commented out | ||
33 | # serve to show the default. | ||
34 | |||
35 | import sys | ||
36 | import os | ||
37 | |||
38 | sys.path.append(os.path.abspath('_exts')) | ||
39 | |||
40 | #import taler_sphinx_theme | ||
41 | |||
42 | # If extensions (or modules to document with autodoc) are in another directory, | ||
43 | # add these directories to sys.path here. If the directory is relative to the | ||
44 | # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
45 | #sys.path.insert(0, os.path.abspath('.')) | ||
46 | |||
47 | # -- General configuration ------------------------------------------------ | ||
48 | |||
49 | # If your documentation needs a minimal Sphinx version, state it here. | ||
50 | needs_sphinx = '1.8.5' | ||
51 | |||
52 | # Add any Sphinx extension module names here, as strings. They can be | ||
53 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
54 | # ones. | ||
55 | extensions = [ | ||
56 | 'sphinx.ext.todo', | ||
57 | 'sphinx.ext.imgmath', | ||
58 | ] | ||
59 | |||
60 | # Add any paths that contain templates here, relative to this directory. | ||
61 | templates_path = ['_templates'] | ||
62 | |||
63 | source_suffix = { | ||
64 | '.rst': 'restructuredtext', | ||
65 | } | ||
66 | |||
67 | # The encoding of source files. | ||
68 | #source_encoding = 'utf-8-sig' | ||
69 | |||
70 | # The master toctree document. | ||
71 | master_doc = 'tos' | ||
72 | |||
73 | # General information about the project. | ||
74 | project = u'tos' | ||
75 | copyright = u'2014-2020 Taler Systems SA (GPLv3+ or GFDL 1.3+)' | ||
76 | |||
77 | # The version info for the project you're documenting, acts as replacement for | ||
78 | # |version| and |release|, also used in various other places throughout the | ||
79 | # built documents. | ||
80 | # | ||
81 | # The short X.Y version. | ||
82 | version = '0' | ||
83 | # The full version, including alpha/beta/rc tags. | ||
84 | release = '0' | ||
85 | |||
86 | # The language for content autogenerated by Sphinx. Refer to documentation | ||
87 | # for a list of supported languages. | ||
88 | # language = "en de" | ||
89 | |||
90 | # There are two options for replacing |today|: either, you set today to some | ||
91 | # non-false value, then it is used: | ||
92 | #today = '' | ||
93 | # Else, today_fmt is used as the format for a strftime call. | ||
94 | #today_fmt = '%B %d, %Y' | ||
95 | |||
96 | # List of patterns, relative to source directory, that match files and | ||
97 | # directories to ignore when looking for source files. | ||
98 | exclude_patterns = ['_build', '_exts', 'cf', 'prebuilt'] | ||
99 | |||
100 | # The reST default role (used for this markup: `text`) to use for all | ||
101 | # documents. | ||
102 | # default_role = "ts:type" | ||
103 | |||
104 | locale_dirs = ['locale/'] | ||
105 | gettext_compact = False | ||
106 | |||
107 | # If true, '()' will be appended to :func: etc. cross-reference text. | ||
108 | #add_function_parentheses = True | ||
109 | |||
110 | # If true, the current module name will be prepended to all description | ||
111 | # unit titles (such as .. function::). | ||
112 | #add_module_names = True | ||
113 | |||
114 | # If true, sectionauthor and moduleauthor directives will be shown in the | ||
115 | # output. They are ignored by default. | ||
116 | #show_authors = False | ||
117 | |||
118 | # The name of the Pygments (syntax highlighting) style to use. | ||
119 | pygments_style = 'sphinx' | ||
120 | |||
121 | # A list of ignored prefixes for module index sorting. | ||
122 | #modindex_common_prefix = [] | ||
123 | |||
124 | # If true, keep warnings as "system message" paragraphs in the built documents. | ||
125 | #keep_warnings = False | ||
126 | |||
127 | # -- Options for HTML output ---------------------------------------------- | ||
128 | |||
129 | # The theme to use for HTML and HTML Help pages. See the documentation for | ||
130 | # a list of builtin themes. | ||
131 | html_theme = 'epub' | ||
132 | |||
133 | #html_theme_path = taler_sphinx_theme.html_theme_path() | ||
134 | |||
135 | #html_sidebars = {'**': ['logo-text.html', 'globaltoc.html', 'searchbox.html']} | ||
136 | |||
137 | rst_epilog = "" | ||
138 | |||
139 | html_show_sphinx = False | ||
140 | |||
141 | html_theme_options = { | ||
142 | # Set the name of the project to appear in the sidebar | ||
143 | "relbar1": "false", | ||
144 | "footer": "false", | ||
145 | } | ||
146 | |||
147 | # Add any paths that contain custom themes here, relative to this directory. | ||
148 | #html_theme_path = [] | ||
149 | |||
150 | # The name for this set of Sphinx documents. If None, it defaults to | ||
151 | # "<project> v<release> documentation". | ||
152 | html_title = "Taler Terms of Service" | ||
153 | |||
154 | # A shorter title for the navigation bar. Default is the same as html_title. | ||
155 | html_short_title = "Terms of Service" | ||
156 | |||
157 | # The name of an image file (relative to this directory) to place at the top | ||
158 | # of the sidebar. | ||
159 | #html_logo = None | ||
160 | |||
161 | # The name of an image file (within the static path) to use as favicon of the | ||
162 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | ||
163 | # pixels large. | ||
164 | #html_favicon = None | ||
165 | |||
166 | # Add any paths that contain custom static files (such as style sheets) here, | ||
167 | # relative to this directory. They are copied after the builtin static files, | ||
168 | # so a file named "default.css" will overwrite the builtin "default.css". | ||
169 | # html_static_path = ['_static'] | ||
170 | |||
171 | # Add any extra paths that contain custom files (such as robots.txt or | ||
172 | # .htaccess) here, relative to this directory. These files are copied | ||
173 | # directly to the root of the documentation. | ||
174 | #html_extra_path = [] | ||
175 | |||
176 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | ||
177 | # using the given strftime format. | ||
178 | #html_last_updated_fmt = '%b %d, %Y' | ||
179 | |||
180 | # If true, SmartyPants will be used to convert quotes and dashes to | ||
181 | # typographically correct entities. | ||
182 | #html_use_smartypants = True | ||
183 | |||
184 | # Custom sidebar templates, maps document names to template names. | ||
185 | #html_sidebars = {} | ||
186 | |||
187 | # Additional templates that should be rendered to pages, maps page names to | ||
188 | # template names. | ||
189 | #html_additional_pages = {} | ||
190 | |||
191 | # If false, no module index is generated. | ||
192 | #html_domain_indices = True | ||
193 | |||
194 | # If false, no index is generated. | ||
195 | #html_use_index = True | ||
196 | |||
197 | # If true, the index is split into individual pages for each letter. | ||
198 | #html_split_index = False | ||
199 | |||
200 | # If true, links to the reST sources are added to the pages. | ||
201 | #html_show_sourcelink = True | ||
202 | |||
203 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | ||
204 | html_show_sphinx = False | ||
205 | |||
206 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | ||
207 | #html_show_copyright = True | ||
208 | |||
209 | # If true, an OpenSearch description file will be output, and all pages will | ||
210 | # contain a <link> tag referring to it. The value of this option must be the | ||
211 | # base URL from which the finished HTML is served. | ||
212 | #html_use_opensearch = '' | ||
213 | |||
214 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | ||
215 | #html_file_suffix = None | ||
216 | |||
217 | # -- Options for LaTeX output --------------------------------------------- | ||
218 | |||
219 | latex_elements = { | ||
220 | # The paper size ('letterpaper' or 'a4paper'). | ||
221 | #'papersize': 'letterpaper', | ||
222 | |||
223 | # The font size ('10pt', '11pt' or '12pt'). | ||
224 | #'pointsize': '10pt', | ||
225 | |||
226 | # Additional stuff for the LaTeX preamble. | ||
227 | #'preamble': '', | ||
228 | } | ||
229 | |||
230 | # Grouping the document tree into LaTeX files. List of tuples | ||
231 | # (source start file, target name, title, | ||
232 | # author, documentclass [howto, manual, or own class]). | ||
233 | latex_documents = [ | ||
234 | ('tos', 'tos.tex', | ||
235 | 'Terms of Service', 'GNU Taler team', 'manual'), | ||
236 | ] | ||
237 | |||
238 | # The name of an image file (relative to this directory) to place at the top of | ||
239 | # the title page. | ||
240 | #latex_logo = None | ||
241 | |||
242 | # For "manual" documents, if this is true, then toplevel headings are parts, | ||
243 | # not chapters. | ||
244 | #latex_use_parts = False | ||
245 | |||
246 | # If true, show page references after internal links. | ||
247 | #latex_show_pagerefs = False | ||
248 | |||
249 | # If true, show URL addresses after external links. | ||
250 | #latex_show_urls = False | ||
251 | |||
252 | # Documents to append as an appendix to all manuals. | ||
253 | # latex_appendices = ["fdl-1.3"] | ||
254 | |||
255 | # If false, no module index is generated. | ||
256 | #latex_domain_indices = True | ||
257 | |||
258 | # -- Options for manual page output --------------------------------------- | ||
259 | |||
260 | # If true, show URL addresses after external links. | ||
261 | #man_show_urls = False | ||
262 | |||
263 | # -- Options for Texinfo output ------------------------------------------- | ||
264 | |||
265 | # Documents to append as an appendix to all manuals. | ||
266 | #texinfo_appendices = [] | ||
267 | |||
268 | # If false, no module index is generated. | ||
269 | #texinfo_domain_indices = True | ||
270 | |||
271 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | ||
272 | #texinfo_show_urls = 'footnote' | ||
273 | |||
274 | # If true, do not generate a @detailmenu in the "Top" node's menu. | ||
275 | #texinfo_no_detailmenu = False | ||
276 | |||
277 | |||
278 | # -- Options for epub output ---------------------------- | ||
279 | |||
280 | epub_basename = "tos" | ||
281 | |||
282 | epub_title = "Terms of Service" | ||