15
15
# If extensions (or modules to document with autodoc) are in another directory,
16
16
# add these directories to sys.path here. If the directory is relative to the
17
17
# documentation root, use os.path.abspath to make it absolute, like shown here.
18
- #sys.path.insert(0, os.path.abspath('.'))
18
+ #sys.path.insert(0, os.path.abspath('.'))
19
19
20
20
# -- General configuration ------------------------------------------------
21
21
22
22
# If your documentation needs a minimal Sphinx version, state it here.
23
- #needs_sphinx = '1.0'
23
+ #needs_sphinx = '1.0'
24
24
25
25
# Add any Sphinx extension module names here, as strings. They can be
26
26
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30
30
'sphinx.ext.ifconfig' ,
31
31
'sage_package.sphinx' ,
32
32
'nbsphinx' ,
33
- #'sphinxcontrib.jupyter'
33
+ #'sphinxcontrib.jupyter'
34
34
]
35
35
36
36
# Add any paths that contain templates here, relative to this directory.
42
42
source_suffix = '.rst'
43
43
44
44
# The encoding of source files.
45
- #source_encoding = 'utf-8-sig'
45
+ #source_encoding = 'utf-8-sig'
46
46
47
47
# The master toctree document.
48
48
master_doc = 'index'
70
70
71
71
# There are two options for replacing |today|: either, you set today to some
72
72
# non-false value, then it is used:
73
- #today = ''
73
+ #today = ''
74
74
# Else, today_fmt is used as the format for a strftime call.
75
- #today_fmt = '%B %d, %Y'
75
+ #today_fmt = '%B %d, %Y'
76
76
77
77
# List of patterns, relative to source directory, that match files and
78
78
# directories to ignore when looking for source files.
83
83
default_role = 'math'
84
84
85
85
# If true, '()' will be appended to :func: etc. cross-reference text.
86
- #add_function_parentheses = True
86
+ #add_function_parentheses = True
87
87
88
88
# If true, the current module name will be prepended to all description
89
89
# unit titles (such as .. function::).
90
- #add_module_names = True
90
+ #add_module_names = True
91
91
92
92
# If true, sectionauthor and moduleauthor directives will be shown in the
93
93
# output. They are ignored by default.
94
- #show_authors = False
94
+ #show_authors = False
95
95
96
96
# The name of the Pygments (syntax highlighting) style to use.
97
97
pygments_style = 'sphinx'
98
98
99
99
# A list of ignored prefixes for module index sorting.
100
- #modindex_common_prefix = []
100
+ #modindex_common_prefix = []
101
101
102
102
# If true, keep warnings as "system message" paragraphs in the built documents.
103
- #keep_warnings = False
103
+ #keep_warnings = False
104
104
105
105
# If true, `todo` and `todoList` produce output, else they produce nothing.
106
106
todo_include_todos = True
111
111
# The theme to use for HTML and HTML Help pages. See the documentation for
112
112
# a list of builtin themes.
113
113
html_theme = 'sage' # force `sage` theme (the setting in sage_package.sphinx seems to be ignored by RTD)
114
- #html_theme_path = ['themes']
114
+ #html_theme_path = ['themes']
115
115
116
116
# Theme options are theme-specific and customize the look and feel of a theme
117
117
# further. For a list of options available for each theme, see the
118
118
# documentation.
119
- #html_theme_options = {}
119
+ #html_theme_options = {}
120
120
121
121
# Add any paths that contain custom themes here, relative to this directory.
122
122
html_theme_path = ['themes' ]
126
126
html_title = "More SageMath Tutorials"
127
127
128
128
# A shorter title for the navigation bar. Default is the same as html_title.
129
- #html_short_title = None
129
+ #html_short_title = None
130
130
131
131
# The name of an image file (relative to this directory) to place at the top
132
132
# of the sidebar.
133
- #html_logo = None
133
+ #html_logo = None
134
134
135
135
# The name of an image file (relative to this directory) to use as a favicon of
136
136
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
137
137
# pixels large.
138
- #html_favicon = None
138
+ #html_favicon = None
139
139
140
140
# Add any paths that contain custom static files (such as style sheets) here,
141
141
# relative to this directory. They are copied after the builtin static files,
149
149
150
150
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
151
151
# using the given strftime format.
152
- #html_last_updated_fmt = '%b %d, %Y'
152
+ #html_last_updated_fmt = '%b %d, %Y'
153
153
154
154
# If true, SmartyPants will be used to convert quotes and dashes to
155
155
# typographically correct entities.
156
- #html_use_smartypants = True
156
+ #html_use_smartypants = True
157
157
158
158
# Custom sidebar templates, maps document names to template names.
159
- html_sidebars = {'**' : ['title.html' , 'ipynblink.html' , 'localtoc.html' , 'relations.html' , 'searchbox.html' ]}
159
+ html_sidebars = {'**' : ['title.html' , 'ipynblink.html' , 'localtoc.html' , 'relations.html' , 'searchbox.html' ]}
160
160
161
161
# Additional templates that should be rendered to pages, maps page names to
162
162
# template names.
163
- #html_additional_pages = {}
163
+ #html_additional_pages = {}
164
164
165
165
# If false, no module index is generated.
166
- #html_domain_indices = True
166
+ #html_domain_indices = True
167
167
168
168
# If false, no index is generated.
169
- #html_use_index = True
169
+ #html_use_index = True
170
170
171
171
# If true, the index is split into individual pages for each letter.
172
- #html_split_index = False
172
+ #html_split_index = False
173
173
174
174
# If true, links to the reST sources are added to the pages.
175
175
html_show_sourcelink = True
176
176
html_copy_source = True
177
177
178
178
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
179
- #html_show_sphinx = True
179
+ #html_show_sphinx = True
180
180
181
181
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
182
- #html_show_copyright = True
182
+ #html_show_copyright = True
183
183
184
184
# If true, an OpenSearch description file will be output, and all pages will
185
185
# contain a <link> tag referring to it. The value of this option must be the
186
186
# base URL from which the finished HTML is served.
187
- #html_use_opensearch = ''
187
+ #html_use_opensearch = ''
188
188
189
189
# This is the file name suffix for HTML files (e.g. ".xhtml").
190
- #html_file_suffix = None
190
+ #html_file_suffix = None
191
191
192
192
# Language to be used for generating the HTML full-text search index.
193
193
# Sphinx supports the following languages:
194
194
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
195
195
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
196
- #html_search_language = 'en'
196
+ #html_search_language = 'en'
197
197
198
198
# A dictionary with options for the search language support, empty by default.
199
199
# Now only 'ja' uses this config value
200
- #html_search_options = {'type': 'default'}
200
+ #html_search_options = {'type': 'default'}
201
201
202
202
# The name of a javascript file (relative to the configuration directory) that
203
203
# implements a search results scorer. If empty, the default will be used.
204
- #html_search_scorer = 'scorer.js'
204
+ #html_search_scorer = 'scorer.js'
205
205
206
206
# Output file base name for HTML help builder.
207
207
htmlhelp_basename = 'MoreSageThematicTutorialsdoc'
210
210
211
211
latex_elements = {
212
212
# The paper size ('letterpaper' or 'a4paper').
213
- #'papersize': 'letterpaper',
213
+ #'papersize': 'letterpaper',
214
214
215
215
# The font size ('10pt', '11pt' or '12pt').
216
- #'pointsize': '10pt',
216
+ #'pointsize': '10pt',
217
217
218
218
# Additional stuff for the LaTeX preamble.
219
- 'preamble' : r'''
219
+ 'preamble' : r'''
220
220
\usepackage{amsmath}
221
221
\usepackage{amssymb}
222
222
\newcommand{\ZZ}{\mathbb{Z}}
227
227
''' ,
228
228
229
229
# Latex figure (float) alignment
230
- #'figure_align': 'htbp',
230
+ #'figure_align': 'htbp',
231
231
}
232
232
233
233
# Grouping the document tree into LaTeX files. List of tuples
240
240
241
241
# The name of an image file (relative to this directory) to place at the top of
242
242
# the title page.
243
- #latex_logo = None
243
+ #latex_logo = None
244
244
245
245
# For "manual" documents, if this is true, then toplevel headings are parts,
246
246
# not chapters.
247
- #latex_use_parts = False
247
+ #latex_use_parts = False
248
248
249
249
# If true, show page references after internal links.
250
- #latex_show_pagerefs = False
250
+ #latex_show_pagerefs = False
251
251
252
252
# If true, show URL addresses after external links.
253
- #latex_show_urls = False
253
+ #latex_show_urls = False
254
254
255
255
# Documents to append as an appendix to all manuals.
256
- #latex_appendices = []
256
+ #latex_appendices = []
257
257
258
258
# If false, no module index is generated.
259
- #latex_domain_indices = True
259
+ #latex_domain_indices = True
260
260
261
261
262
262
# -- Options for manual page output ---------------------------------------
269
269
]
270
270
271
271
# If true, show URL addresses after external links.
272
- #man_show_urls = False
272
+ #man_show_urls = False
273
273
274
274
275
275
# -- Options for Texinfo output -------------------------------------------
284
284
]
285
285
286
286
# Documents to append as an appendix to all manuals.
287
- #texinfo_appendices = []
287
+ #texinfo_appendices = []
288
288
289
289
# If false, no module index is generated.
290
- #texinfo_domain_indices = True
290
+ #texinfo_domain_indices = True
291
291
292
292
# How to display URL addresses: 'footnote', 'no', or 'inline'.
293
- #texinfo_show_urls = 'footnote'
293
+ #texinfo_show_urls = 'footnote'
294
294
295
295
# If true, do not generate a @detailmenu in the "Top" node's menu.
296
- #texinfo_no_detailmenu = False
296
+ # texinfo_no_detailmenu = False
297
+
297
298
298
299
def rtd_finalize (app , exception ):
299
300
import subprocess
300
301
if exception is None :
301
- #subprocess.call("make jupyter", shell=True)
302
+ #subprocess.call("make jupyter", shell=True)
302
303
subprocess .call ("make ipynb" , shell = True )
303
304
subprocess .call ("make web" , shell = True )
304
305
306
+
305
307
def setup (app ):
306
308
import os
307
309
if os .environ .get ('READTHEDOCS' ) == 'True' :
308
310
app .connect ('build-finished' , rtd_finalize )
309
311
312
+
310
313
# -- Options for Jupyter output ------------------------------------------
311
314
312
315
# Conversion Mode Settings
@@ -325,24 +328,21 @@ def setup(app):
325
328
"kernelspec" : {
326
329
"display_name" : "SageMath" ,
327
330
"language" : "SageMath" ,
328
- "name" : "sagemath"
329
- },
331
+ "name" : "sagemath" },
330
332
"file_extension" : ".sage" ,
331
333
},
332
334
"python3" : {
333
335
"kernelspec" : {
334
336
"display_name" : "Python" ,
335
337
"language" : "python3" ,
336
- "name" : "python3"
337
- },
338
+ "name" : "python3" },
338
339
"file_extension" : ".py" ,
339
340
},
340
341
"julia" : {
341
342
"kernelspec" : {
342
343
"display_name" : "Julia 0.6.0" ,
343
344
"language" : "julia" ,
344
- "name" : "julia-0.6"
345
- },
345
+ "name" : "julia-0.6" },
346
346
"file_extension" : ".jl"
347
347
}
348
348
}
0 commit comments