|
10 | 10 | # add these directories to sys.path here. If the directory is relative to the |
11 | 11 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
12 | 12 | # |
13 | | -project = 'Kessler' |
14 | | -copyright = "2020, 2021, 2022, 2023, 2024, 2025, Kessler contributors" |
| 13 | +project = 'kessler' |
| 14 | +copyright = "2020-2025, Kessler contributors" |
15 | 15 | author = 'Giacomo Acciarini, Atılım Güneş Baydin, Francesco Pinto' |
16 | 16 |
|
17 | 17 |
|
18 | 18 | # The full version, including alpha/beta/rc tags |
19 | 19 | import kessler |
20 | | -import sys |
21 | | -import os |
22 | | -sys.path.insert(0, os.path.abspath('../')) # Add the root directory of your repo |
23 | 20 |
|
24 | 21 | release = kessler.__version__ |
25 | 22 |
|
|
30 | 27 | # Add any Sphinx extension module names here, as strings. They can be |
31 | 28 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
32 | 29 | # ones. |
33 | | -extensions = ["myst_nb", "sphinx.ext.autodoc", "sphinx.ext.doctest", "sphinx.ext.intersphinx", "sphinx.ext.autosummary","sphinx.ext.napoleon"] |
34 | | - |
35 | | - |
36 | | -# build the templated autosummary files |
37 | | -autosummary_generate = True |
38 | | -autosummary_imported_members = False |
39 | | -napoleon_google_docstring = True |
40 | | -numpydoc_show_class_members = False |
41 | | -panels_add_bootstrap_css = False |
42 | | - |
43 | | -autosectionlabel_prefix_document = True |
44 | | - |
45 | | -# katex options |
46 | | -# |
47 | | -# |
48 | | -katex_prerender = True |
49 | | - |
50 | | -napoleon_use_ivar = True |
| 30 | +extensions = ["myst_nb", |
| 31 | + "sphinx.ext.intersphinx", |
| 32 | + "sphinx.ext.autodoc", |
| 33 | + "sphinx.ext.autosummary", |
| 34 | + "sphinx.ext.doctest", |
| 35 | + ] |
51 | 36 |
|
52 | 37 | # Add any paths that contain templates here, relative to this directory. |
53 | 38 | templates_path = ["_templates"] |
|
64 | 49 | # List of patterns, relative to source directory, that match files and |
65 | 50 | # directories to ignore when looking for source files. |
66 | 51 | # This pattern also affects html_static_path and html_extra_path. |
67 | | -exclude_patterns = ["_build", ".DS_Store",'jupyter_execute/**/*.ipynb','jupyter_execute/*.ipynb'] |
| 52 | +exclude_patterns = ["_build", ".DS_Store"] |
68 | 53 |
|
69 | 54 |
|
70 | 55 | # -- Options for HTML output ------------------------------------------------- |
|
97 | 82 | nb_execution_mode = "force" |
98 | 83 |
|
99 | 84 | nb_execution_excludepatterns = ['basics.ipynb','cdms_analysis_and_plotting.ipynb','LSTM_training.ipynb'] |
100 | | -#autosummary_ignore_module = [''] |
| 85 | + |
| 86 | +# Force printing traceback to stderr on execution error. |
| 87 | +nb_execution_show_tb = True |
| 88 | + |
| 89 | +# Set a longer timeout for notebook execution. |
| 90 | +nb_execution_timeout = 120 |
101 | 91 |
|
102 | 92 | latex_engine = "xelatex" |
103 | 93 |
|
|
0 commit comments