Skip to content

Commit 322e663

Browse files
committed
a bit of cleanup
1 parent 097eba4 commit 322e663

2 files changed

Lines changed: 15 additions & 26 deletions

File tree

.github/workflows/build.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ jobs:
3535
pip install sphinx-book-theme
3636
pip install myst-nb
3737
cd docs
38-
sphinx-apidoc -o _autosummary ../kessler # Generate API documentation
3938
make html linkcheck
4039
- name: Test
4140
run: |

docs/conf.py

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,13 @@
1010
# add these directories to sys.path here. If the directory is relative to the
1111
# documentation root, use os.path.abspath to make it absolute, like shown here.
1212
#
13-
project = 'Kessler'
14-
copyright = "2020, 2021, 2022, 2023, 2024, 2025, Kessler contributors"
13+
project = 'kessler'
14+
copyright = "2020-2025, Kessler contributors"
1515
author = 'Giacomo Acciarini, Atılım Güneş Baydin, Francesco Pinto'
1616

1717

1818
# The full version, including alpha/beta/rc tags
1919
import kessler
20-
import sys
21-
import os
22-
sys.path.insert(0, os.path.abspath('../')) # Add the root directory of your repo
2320

2421
release = kessler.__version__
2522

@@ -30,24 +27,12 @@
3027
# Add any Sphinx extension module names here, as strings. They can be
3128
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3229
# 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+
]
5136

5237
# Add any paths that contain templates here, relative to this directory.
5338
templates_path = ["_templates"]
@@ -64,7 +49,7 @@
6449
# List of patterns, relative to source directory, that match files and
6550
# directories to ignore when looking for source files.
6651
# 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"]
6853

6954

7055
# -- Options for HTML output -------------------------------------------------
@@ -97,7 +82,12 @@
9782
nb_execution_mode = "force"
9883

9984
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
10191

10292
latex_engine = "xelatex"
10393

0 commit comments

Comments
 (0)