|
16 | 16 | import doubleml
|
17 | 17 | import plotly.io as pio
|
18 | 18 |
|
19 |
| -sys.path.insert(0, os.path.abspath('..')) |
| 19 | +sys.path.insert(0, os.path.abspath("..")) |
20 | 20 |
|
21 | 21 | # Set the default renderer for Plotly
|
22 |
| -pio.renderers.default = 'sphinx_gallery' |
| 22 | +pio.renderers.default = "sphinx_gallery" |
23 | 23 |
|
24 | 24 | # -- Project information -----------------------------------------------------
|
25 | 25 |
|
26 |
| -project = 'DoubleML' |
27 |
| -copyright = '2023, Bach, P., Chernozhukov, V., Klaassen, S., Kurz, M. S., and Spindler, M.' |
28 |
| -author = 'Bach, P., Chernozhukov, V., Klaassen, S., Kurz, M. S., and Spindler, M.' |
| 26 | +project = "DoubleML" |
| 27 | +copyright = "2023, Bach, P., Chernozhukov, V., Klaassen, S., Kurz, M. S., and Spindler, M." |
| 28 | +author = "Bach, P., Chernozhukov, V., Klaassen, S., Kurz, M. S., and Spindler, M." |
29 | 29 |
|
30 | 30 |
|
31 | 31 | # -- General configuration ---------------------------------------------------
|
|
34 | 34 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
35 | 35 | # ones.
|
36 | 36 | extensions = [
|
37 |
| - 'sphinx.ext.autodoc', |
38 |
| - 'sphinx.ext.autosummary', |
39 |
| - 'sphinx.ext.coverage', |
40 |
| - 'sphinx.ext.doctest', |
41 |
| - 'sphinx.ext.graphviz', |
42 |
| - 'sphinx.ext.intersphinx', |
43 |
| - 'sphinx.ext.mathjax', |
44 |
| - 'sphinx.ext.napoleon', |
45 |
| - 'IPython.sphinxext.ipython_console_highlighting', |
46 |
| - 'IPython.sphinxext.ipython_directive', |
47 |
| - 'matplotlib.sphinxext.plot_directive', |
48 |
| - 'nbsphinx', |
49 |
| - 'sphinx_gallery.load_style', |
50 |
| - 'sphinx_copybutton', |
51 |
| - 'sphinx_design', |
52 |
| - 'jupyter_sphinx', |
| 37 | + "sphinx.ext.autodoc", |
| 38 | + "sphinx.ext.autosummary", |
| 39 | + "sphinx.ext.coverage", |
| 40 | + "sphinx.ext.doctest", |
| 41 | + "sphinx.ext.graphviz", |
| 42 | + "sphinx.ext.intersphinx", |
| 43 | + "sphinx.ext.mathjax", |
| 44 | + "sphinx.ext.napoleon", |
| 45 | + "IPython.sphinxext.ipython_console_highlighting", |
| 46 | + "IPython.sphinxext.ipython_directive", |
| 47 | + "matplotlib.sphinxext.plot_directive", |
| 48 | + "nbsphinx", |
| 49 | + "sphinx_gallery.load_style", |
| 50 | + "sphinx_copybutton", |
| 51 | + "sphinx_design", |
| 52 | + "jupyter_sphinx", |
53 | 53 | ]
|
54 | 54 |
|
55 | 55 | # sphinx-panels shouldn't add bootstrap css since the pydata-sphinx-theme
|
56 | 56 | # already loads it
|
57 | 57 | panels_add_bootstrap_css = False
|
58 | 58 |
|
59 | 59 | # Add any paths that contain templates here, relative to this directory.
|
60 |
| -templates_path = ['_templates'] |
| 60 | +templates_path = ["_templates"] |
61 | 61 |
|
62 | 62 | # List of patterns, relative to source directory, that match files and
|
63 | 63 | # directories to ignore when looking for source files.
|
64 | 64 | # This pattern also affects html_static_path and html_extra_path.
|
65 |
| -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'shared/*'] |
| 65 | +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "shared/*"] |
66 | 66 |
|
67 |
| -master_doc = 'index' |
| 67 | +master_doc = "index" |
68 | 68 |
|
69 |
| -autoclass_content = 'class' |
| 69 | +autoclass_content = "class" |
70 | 70 | autosummary_generate = True
|
71 | 71 |
|
72 | 72 | # -- Options for HTML output -------------------------------------------------
|
73 | 73 |
|
74 | 74 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
75 | 75 | # a list of builtin themes.
|
76 |
| -html_theme = 'pydata_sphinx_theme' |
| 76 | +html_theme = "pydata_sphinx_theme" |
77 | 77 |
|
78 | 78 | # version for the switcher
|
79 | 79 | if "dev" in doubleml.__version__:
|
|
124 | 124 | "json_url": "https://docs.doubleml.org/dev/_static/switcher.json",
|
125 | 125 | "version_match": version,
|
126 | 126 | },
|
127 |
| - "show_version_warning_banner": True, |
| 127 | + "show_version_warning_banner": False, # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/announcements.html#version-warning-banners |
128 | 128 | "check_switcher": True,
|
129 | 129 | "announcement": "Interested to learn more? We offer <a href='https://trainings.doubleml.org/'>DoubleML Trainings!</a>",
|
130 | 130 | }
|
131 | 131 |
|
132 |
| -html_extra_path = ['../img/logo.png', '../img/logo_dark.png'] |
133 |
| -html_favicon = '../img/favicon.ico' |
| 132 | +html_extra_path = ["../img/logo.png", "../img/logo_dark.png"] |
| 133 | +html_favicon = "../img/favicon.ico" |
134 | 134 |
|
135 | 135 | html_sidebars = {
|
136 |
| - '**': [ |
137 |
| - 'logo.html', |
138 |
| - 'search-field.html', |
139 |
| - 'sidebar-nav-bs.html', |
| 136 | + "**": [ |
| 137 | + "logo.html", |
| 138 | + "search-field.html", |
| 139 | + "sidebar-nav-bs.html", |
140 | 140 | ],
|
141 |
| - 'index': [], |
142 |
| - 'intro/install': [], |
143 |
| - 'intro/intro': [], |
144 |
| - 'workflow/workflow': [], |
145 |
| - 'literature/literature': [], |
146 |
| - 'release/release': [], |
| 141 | + "index": [], |
| 142 | + "intro/install": [], |
| 143 | + "intro/intro": [], |
| 144 | + "workflow/workflow": [], |
| 145 | + "literature/literature": [], |
| 146 | + "release/release": [], |
147 | 147 | }
|
148 | 148 |
|
149 | 149 | html_context = {
|
|
156 | 156 | # Add any paths that contain custom static files (such as style sheets) here,
|
157 | 157 | # relative to this directory. They are copied after the builtin static files,
|
158 | 158 | # so a file named "default.css" will overwrite the builtin "default.css".
|
159 |
| -html_static_path = ['_static'] |
160 |
| -html_css_files = ['css/custom.css'] |
| 159 | +html_static_path = ["_static"] |
| 160 | +html_css_files = ["css/custom.css"] |
161 | 161 |
|
162 | 162 | # -- Extension configuration -------------------------------------------------
|
163 | 163 |
|
164 | 164 | nbsphinx_thumbnails = {
|
165 |
| - 'examples/py_double_ml_sensitivity': '_static/sensitivity_example_nb.png', |
166 |
| - 'examples/py_double_ml_gate_sensitivity': '_static/sensitivity_example_nb.png', |
167 |
| - 'examples/py_double_ml_firststage': '_static/firststage_example_nb.png', |
168 |
| - 'examples/py_double_ml_basic_iv': '_static/basic_iv_example_nb.png', |
169 |
| - 'examples/py_double_ml_robust_iv': '_static/basic_iv_example_nb.png', |
170 |
| - 'examples/R_double_ml_basic_iv': '_static/basic_iv_example_nb.png', |
171 |
| - 'examples/py_double_ml_robust_iv': '_static/robust_iv_example_nb.png', |
172 |
| - 'examples/py_double_ml_ssm': '_static/ssm_example_nb.svg', |
173 |
| - 'examples/R_double_ml_ssm': '_static/ssm_example_nb.svg', |
174 |
| - 'examples/py_double_ml_sensitivity_booking': '_static/dag_usecase_revised.png', |
| 165 | + "examples/py_double_ml_sensitivity": "_static/sensitivity_example_nb.png", |
| 166 | + "examples/py_double_ml_gate_sensitivity": "_static/sensitivity_example_nb.png", |
| 167 | + "examples/py_double_ml_firststage": "_static/firststage_example_nb.png", |
| 168 | + "examples/py_double_ml_basic_iv": "_static/basic_iv_example_nb.png", |
| 169 | + "examples/py_double_ml_robust_iv": "_static/basic_iv_example_nb.png", |
| 170 | + "examples/R_double_ml_basic_iv": "_static/basic_iv_example_nb.png", |
| 171 | + "examples/py_double_ml_robust_iv": "_static/robust_iv_example_nb.png", |
| 172 | + "examples/py_double_ml_ssm": "_static/ssm_example_nb.svg", |
| 173 | + "examples/R_double_ml_ssm": "_static/ssm_example_nb.svg", |
| 174 | + "examples/py_double_ml_sensitivity_booking": "_static/dag_usecase_revised.png", |
175 | 175 | }
|
176 | 176 |
|
177 |
| -copybutton_prompt_text = r'>>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: | {2,5}\.\.\.\.:' |
| 177 | +copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: | {2,5}\.\.\.\.:" |
178 | 178 | copybutton_prompt_is_regexp = True
|
179 | 179 |
|
180 | 180 | # config of sphinx gallery for examples
|
|
195 | 195 |
|
196 | 196 | # intersphinx configuration
|
197 | 197 | intersphinx_mapping = {
|
198 |
| - 'python': ('https://docs.python.org/{.major}'.format(sys.version_info), None), |
199 |
| - 'sklearn': ('https://scikit-learn.org/stable/', None), |
200 |
| - 'numpy': ('https://numpy.org/doc/stable/', None), |
201 |
| - 'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None), |
202 |
| - 'statsmodels': ('https://www.statsmodels.org/stable/', None), |
| 198 | + "python": ("https://docs.python.org/{.major}".format(sys.version_info), None), |
| 199 | + "sklearn": ("https://scikit-learn.org/stable/", None), |
| 200 | + "numpy": ("https://numpy.org/doc/stable/", None), |
| 201 | + "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None), |
| 202 | + "statsmodels": ("https://www.statsmodels.org/stable/", None), |
203 | 203 | }
|
204 | 204 |
|
205 | 205 | linkcheck_ignore = [
|
206 | 206 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
207 |
| - 'https://doi.org/10.1093/ectj/utaa001', |
| 207 | + "https://doi.org/10.1093/ectj/utaa001", |
208 | 208 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
209 |
| - 'https://doi.org/10.1111/ectj.12097', |
| 209 | + "https://doi.org/10.1111/ectj.12097", |
210 | 210 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
211 |
| - 'https://doi.org/10.2307/2171802', |
| 211 | + "https://doi.org/10.2307/2171802", |
212 | 212 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
213 |
| - 'https://doi.org/10.2307/1912705', |
| 213 | + "https://doi.org/10.2307/1912705", |
214 | 214 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
215 |
| - 'https://doi.org/10.1093/ectj/utaa027', |
| 215 | + "https://doi.org/10.1093/ectj/utaa027", |
216 | 216 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
217 |
| - 'https://doi.org/10.1111/rssb.12026', |
| 217 | + "https://doi.org/10.1111/rssb.12026", |
218 | 218 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
219 |
| - 'https://doi.org/10.1111/rssa.12623', |
| 219 | + "https://doi.org/10.1111/rssa.12623", |
220 | 220 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
221 |
| - 'https://doi.org/10.1146/annurev-economics-012315-015826', |
| 221 | + "https://doi.org/10.1146/annurev-economics-012315-015826", |
222 | 222 | # Valid DOI, Causes 418 Client Error: unknown for url:...
|
223 |
| - 'https://doi.org/10.1109/TIT.2014.2343629', |
| 223 | + "https://doi.org/10.1109/TIT.2014.2343629", |
224 | 224 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
225 |
| - 'https://doi.org/10.1093/ectj/utaa001', |
| 225 | + "https://doi.org/10.1093/ectj/utaa001", |
226 | 226 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
227 |
| - 'https://doi.org/10.1111/0034-6527.00321', |
| 227 | + "https://doi.org/10.1111/0034-6527.00321", |
228 | 228 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
229 |
| - 'https://doi.org/10.1016/j.jeconom.2020.06.003', |
| 229 | + "https://doi.org/10.1016/j.jeconom.2020.06.003", |
230 | 230 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
231 |
| - 'https://doi.org/10.1080/07350015.2021.1895815', |
| 231 | + "https://doi.org/10.1080/07350015.2021.1895815", |
232 | 232 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
233 |
| - 'https://doi.org/10.1198/jbes.2010.07136', |
| 233 | + "https://doi.org/10.1198/jbes.2010.07136", |
234 | 234 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
235 |
| - 'https://doi.org/10.1111/rssb.12348', |
| 235 | + "https://doi.org/10.1111/rssb.12348", |
236 | 236 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
237 |
| - 'https://doi.org/10.1145/3460231.3474231', |
| 237 | + "https://doi.org/10.1145/3460231.3474231", |
238 | 238 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
239 |
| - 'https://dl.acm.org/doi/10.1145/3447545.3451181', |
| 239 | + "https://dl.acm.org/doi/10.1145/3447545.3451181", |
240 | 240 | # Pipelines notebook has to be reworked
|
241 |
| - 'https://mlr3book.mlr-org.com/pipelines.html', |
| 241 | + "https://mlr3book.mlr-org.com/pipelines.html", |
242 | 242 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
243 |
| - 'https://doi.org/10.1080/07350015.2023.2271071', |
| 243 | + "https://doi.org/10.1080/07350015.2023.2271071", |
244 | 244 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
245 |
| - 'https://doi.org/10.1093/restud/rdt044', |
| 245 | + "https://doi.org/10.1093/restud/rdt044", |
246 | 246 | # Valid DOI; 'Connection aborted.', RemoteDisconnected ...
|
247 |
| - 'https://CRAN.R-project.org/package=mlr3learners', |
| 247 | + "https://CRAN.R-project.org/package=mlr3learners", |
248 | 248 | # Valid DOI (error not replicable), Causes 404 Client Error: Not Found for url:...
|
249 |
| - 'https://doi.org/10.1214/14-AOS1204', |
| 249 | + "https://doi.org/10.1214/14-AOS1204", |
250 | 250 | # Valid DOI (error not replicable), Causes 404 Client Error: Not Found for url:...
|
251 |
| - 'https://doi.org/10.1214/14-AOS1221', |
| 251 | + "https://doi.org/10.1214/14-AOS1221", |
252 | 252 | # Valid DOI (error not replicable), Causes 404 Client Error: Not Found for url:...
|
253 |
| - 'https://doi.org/10.1214/17-AOS1671', |
| 253 | + "https://doi.org/10.1214/17-AOS1671", |
254 | 254 | # Valid DOI (error not replicable), Causes 404 Client Error: Not Found for url:...
|
255 |
| - 'https://dx.doi.org/10.1214/13-AOS1161', |
| 255 | + "https://dx.doi.org/10.1214/13-AOS1161", |
256 | 256 | # Valid DOI (error not replicable), Causes 404 Client Error: Not Found for url:...
|
257 |
| - 'https://dx.doi.org/10.1214/14-AOS1230', |
| 257 | + "https://dx.doi.org/10.1214/14-AOS1230", |
258 | 258 | # Valid URL Failed to establish a new connection: [Errno 111] Connection refused' ...
|
259 |
| - 'https://glmnet.stanford.edu/', |
| 259 | + "https://glmnet.stanford.edu/", |
260 | 260 | # Valid URL Failed to establish a new connection: [Errno 111] Connection refused' ...
|
261 |
| - 'https://glmnet.stanford.edu/index.html', |
| 261 | + "https://glmnet.stanford.edu/index.html", |
262 | 262 | # Valid URL Failed to establish a new connection: [Errno 111] Connection refused' ...
|
263 |
| - 'https://glmnet.stanford.edu/reference/cv.glmnet.html', |
| 263 | + "https://glmnet.stanford.edu/reference/cv.glmnet.html", |
264 | 264 | # Valid URL (error not replicable), Causes 409 Client Error: Too Many Requests for url
|
265 |
| - 'http://dx.doi.org/10.2139/ssrn.3619201', |
| 265 | + "http://dx.doi.org/10.2139/ssrn.3619201", |
266 | 266 | # Valid URL, Causes ConnectTimeoutError
|
267 |
| - 'https://folia.unifr.ch/global/documents/306524', |
| 267 | + "https://folia.unifr.ch/global/documents/306524", |
268 | 268 | # Valid DOI; Causes 403 Client Error: Forbidden for url:...
|
269 |
| - 'https://doi.org/10.1146/annurev-economics-051520-021409', |
| 269 | + "https://doi.org/10.1146/annurev-economics-051520-021409", |
270 | 270 | # Valdi DOI; Causes 504 Server Error: Gateway Time-out for ...
|
271 |
| - 'https://doi.org/10.1017/CBO9781139060035.008' |
| 271 | + "https://doi.org/10.1017/CBO9781139060035.008", |
272 | 272 | ]
|
273 | 273 |
|
274 | 274 | # To execute R code via jupyter-execute one needs to install the R kernel for jupyter
|
275 | 275 | # https://github.com/IRkernel/IRkernel
|
276 | 276 |
|
277 |
| -jupyter_execute_default_kernel = 'ir' |
| 277 | +jupyter_execute_default_kernel = "ir" |
278 | 278 | jupyter_sphinx_linenos = False
|
279 | 279 |
|
280 | 280 | # option to disable the execution of notebooks
|
|
0 commit comments