-
Notifications
You must be signed in to change notification settings - Fork 1
/
conf.py
169 lines (127 loc) · 4.58 KB
/
conf.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# Configuration file for the Jupinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'prebinder'
copyright = '2019, Shreeram'
author = 'Shreeram'
# The short X.Y version
version = '1.0'
# The full version, including alpha/beta/rc tags
release = '1.0'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinxcontrib.jupyter',
'sphinxcontrib.bibtex',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['static']
# -- Extension configuration -------------------------------------------------
# -- jupyter build configuration ---------------------------------------------------
jupyter_kernels = {
"julia-1.1": {
"file_extension": ".jl",
"kernelspec": {
"display_name": "Julia 1.1",
"language": "julia",
"name": "julia-1.1"
}
},
"python2": {
"file_extension": ".py",
"kernelspec": {
"display_name": "Python",
"language": "python2",
"name": "python2"
}
},
"python3": {
"file_extension": ".py",
"kernelspec": {
"display_name": "Python",
"language": "python3",
"name": "python3"
}
}
}
# --------------------------------------------
# jupyter Sphinx Extension conversion settings
# --------------------------------------------
# Conversion Mode Settings
# If "all", convert codes and texts into notebook
# If "code", convert codes only
jupyter_conversion_mode = "all"
jupyter_write_metadata = False
# Location for _static folder
jupyter_static_file_path = ["source/_static"]
# Configure jupyter headers
jupyter_headers = {
"python3": [
# nbformat.v4.new_code_cell("%autosave 0") #@mmcky please make this an option
],
"julia": [
],
}
# Filename for the file containing the welcome block
jupyter_welcome_block = ""
#Adjust links to target html (rather than ipynb)
jupyter_target_html = False
#path to download notebooks from
jupyter_download_nb_urlpath = None
#allow downloading of notebooks
jupyter_download_nb = False
#Use urlprefix images
jupyter_images_urlpath = None
#Allow ipython as a language synonym for blocks to be ipython highlighted
jupyter_lang_synonyms = ["ipython"]
#Execute skip-test code blocks for rendering of website (this will need to be ignored in coverage testing)
jupyter_ignore_skip_test = True
#allow execution of notebooks
jupyter_execute_notebooks = False
# Location of template folder for coverage reports
jupyter_template_coverage_file_path = False
# generate html from IPYNB files
jupyter_generate_html = False
# html template specific to your website needs
jupyter_html_template = ""
# latex template specific to your website needs
jupyter_latex_template = ""
#make website
jupyter_make_site = False
#force markdown image inclusion
jupyter_images_markdown = True
#This is set true by default to pass html to the notebooks
jupyter_allow_html_only=True