Skip to content

chore(docs): resolve ruff lint and format in Friedland Ch. 7 Part 2 (#1216) #1340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
priyam0k wants to merge 3 commits into
base: main
Choose a base branch
from
Open

chore(docs): resolve ruff lint and format in Friedland Ch. 7 Part 2 (#1216) #1340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
29c4e96
chore(docs): resolve ruff lint and format in Friedland Ch. 7 Part 2 (…
priyam0k Sep 11, 2026
81459bd
chore(docs): increase notebook timeout and pre-warm font cache
priyam0k Sep 12, 2026
36568df
fix(docs): make conf.py patch idempotency marker quote-agnostic
priyam0k Sep 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ logo: images/logo.png
# See https://jupyterbook.org/content/execute.html
execute:
execute_notebooks: force
timeout: 180

@henrydingliu henrydingliu Sep 12, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what happens when something times out?

@priyam0k priyam0k Sep 12, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that screenshot with the KeyboardInterrupt is actually what happens when a cell times out

Jupyter Book kills any cell that takes longer than 30s. On RTD's fresh runner, building the font cache took just over 30s, so it interrupted the cell and skipped the rest of the notebook.

Upping the timeout to 180s gives it a safe buffer, and pre-warming the cache in prep_sphinx_conf.py fixes the slow cold start.


# Define the name of the latex output file for PDF builds
latex:
Expand Down
106 changes: 79 additions & 27 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import sys
from pathlib import Path
_DOCS_EXT_DIR = Path(__file__).resolve().parent / '_ext'

_DOCS_EXT_DIR = Path(__file__).resolve().parent / "_ext"
Comment thread
cursor[bot] marked this conversation as resolved.
_p = str(_DOCS_EXT_DIR)
if _p not in sys.path:
sys.path.insert(0, _p)
Expand All @@ -10,38 +11,89 @@
# If you wish to continue using _config.yml, make edits to that file and
# re-generate this one.
###############################################################################
author = 'John Bogaardt, Kenneth Hsu, et. al.'
author = "John Bogaardt, Kenneth Hsu, et. al."
autosummary_generate = True
bibtex_bibfiles = ['library/references.bib']
bibtex_reference_style = 'author_year'
comments_config = {'hypothesis': False, 'utterances': False}
copyright = '2023'
exclude_patterns = ['**.ipynb_checkpoints', '.DS_Store', 'Thumbs.db', '_build']
extensions = ['sphinx_togglebutton', 'sphinx_copybutton', 'myst_nb', 'jupyter_book', 'sphinx_thebe', 'sphinx_comments', 'sphinx_external_toc', 'sphinx.ext.intersphinx', 'sphinx_design', 'sphinx_book_theme', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.doctest', 'sphinx.ext.linkcode', 'numpydoc', 'sphinx.ext.mathjax', 'linkcode', 'sphinxcontrib.bibtex', 'sphinx_jupyterbook_latex', 'sphinx_multitoc_numbering']
bibtex_bibfiles = ["library/references.bib"]
bibtex_reference_style = "author_year"
comments_config = {"hypothesis": False, "utterances": False}
copyright = "2023"
exclude_patterns = ["**.ipynb_checkpoints", ".DS_Store", "Thumbs.db", "_build"]
extensions = [
"sphinx_togglebutton",
"sphinx_copybutton",
"myst_nb",
"jupyter_book",
"sphinx_thebe",
"sphinx_comments",
"sphinx_external_toc",
"sphinx.ext.intersphinx",
"sphinx_design",
"sphinx_book_theme",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.doctest",
"sphinx.ext.linkcode",
"numpydoc",
"sphinx.ext.mathjax",
"linkcode",
"sphinxcontrib.bibtex",
"sphinx_jupyterbook_latex",
"sphinx_multitoc_numbering",
]
external_toc_exclude_missing = False
external_toc_path = '_toc.yml'
html_baseurl = ''
html_favicon = ''
html_logo = 'images/logo.png'
html_sourcelink_suffix = ''
html_theme = 'sphinx_book_theme'
html_theme_options = {'search_bar_text': 'Search this book...', 'launch_buttons': {'notebook_interface': 'classic', 'binderhub_url': '', 'jupyterhub_url': '', 'thebe': False, 'colab_url': '', 'deepnote_url': ''}, 'path_to_docs': 'docs', 'repository_url': 'https://github.com/casact/chainladder-python', 'repository_branch': 'master', 'extra_footer': '', 'home_page_in_toc': True, 'announcement': '', 'analytics': {'google_analytics_id': '', 'plausible_analytics_domain': '', 'plausible_analytics_url': 'https://plausible.io/js/script.js'}, 'use_repository_button': True, 'use_edit_page_button': False, 'use_issues_button': True}
html_title = 'Chainladder - Python'
intersphinx_mapping = {'sklearn': ['https://scikit-learn.org/stable/', None]}
latex_engine = 'pdflatex'
myst_enable_extensions = ['html_admonition', 'colon_fence', 'dollarmath', 'linkify', 'substitution']
myst_url_schemes = ['mailto', 'http', 'https']
external_toc_path = "_toc.yml"
html_baseurl = ""
html_favicon = ""
html_logo = "images/logo.png"
html_sourcelink_suffix = ""
html_theme = "sphinx_book_theme"
html_theme_options = {
"search_bar_text": "Search this book...",
"launch_buttons": {
"notebook_interface": "classic",
"binderhub_url": "",
"jupyterhub_url": "",
"thebe": False,
"colab_url": "",
"deepnote_url": "",
},
"path_to_docs": "docs",
"repository_url": "https://github.com/casact/chainladder-python",
"repository_branch": "master",
"extra_footer": "",
"home_page_in_toc": True,
"announcement": "",
"analytics": {
"google_analytics_id": "",
"plausible_analytics_domain": "",
"plausible_analytics_url": "https://plausible.io/js/script.js",
},
"use_repository_button": True,
"use_edit_page_button": False,
"use_issues_button": True,
}
html_title = "Chainladder - Python"
intersphinx_mapping = {"sklearn": ["https://scikit-learn.org/stable/", None]}
latex_engine = "pdflatex"
myst_enable_extensions = [
"html_admonition",
"colon_fence",
"dollarmath",
"linkify",
"substitution",
]
myst_url_schemes = ["mailto", "http", "https"]
nb_execution_allow_errors = False
nb_execution_cache_path = ''
nb_execution_cache_path = ""
nb_execution_excludepatterns = []
nb_execution_in_temp = False
nb_execution_mode = 'force'
nb_execution_timeout = 30
nb_output_stderr = 'show'
nb_execution_mode = "force"
nb_execution_timeout = 180
nb_output_stderr = "show"
numfig = True
numpydoc_show_class_members = False
pygments_style = 'sphinx'
suppress_warnings = ['myst.domains']
templates_path = ['_templates']
pygments_style = "sphinx"
suppress_warnings = ["myst.domains"]
templates_path = ["_templates"]
use_jupyterbook_latex = True
use_multitoc_numbering = True
Loading
Loading