From 38246bfaf2814ba0634feb9b0a5ab8585aac487a Mon Sep 17 00:00:00 2001 From: Mariagabriela Giorgianni Date: Tue, 12 May 2026 16:44:00 -0400 Subject: [PATCH 1/4] chore: upgrade requirements --- .readthedocs.yml | 4 ++-- requirements/doc.txt | 30 +++++++++++++++--------------- requirements/pip-tools.txt | 20 +++++++++----------- 3 files changed, 26 insertions(+), 28 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index dae90e16..6994f7f4 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -5,9 +5,9 @@ # Set the version of Python and other tools you might need version: 2 build: - os: ubuntu-22.04 + os: ubuntu-24.04 tools: - python: "3.11" + python: "3.12" # Build documentation in the docs/ directory with Sphinx sphinx: diff --git a/requirements/doc.txt b/requirements/doc.txt index 6b7a3ef9..76e39b7f 100644 --- a/requirements/doc.txt +++ b/requirements/doc.txt @@ -1,18 +1,18 @@ # -# This file is autogenerated by pip-compile with Python 3.10 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade # alabaster==0.7.16 # via sphinx -babel==2.17.0 +babel==2.18.0 # via sphinx -beautifulsoup4==4.13.4 +beautifulsoup4==4.14.3 # via pydata-sphinx-theme -certifi==2025.4.26 +certifi==2026.4.22 # via requests -charset-normalizer==3.4.2 +charset-normalizer==3.4.7 # via requests commonmark==0.9.1 # via recommonmark @@ -22,34 +22,34 @@ docutils==0.17.1 # recommonmark # sphinx # sphinx-panels -idna==3.10 +idna==3.14 # via requests -imagesize==1.4.1 +imagesize==2.0.0 # via sphinx jinja2==3.1.6 # via sphinx -markupsafe==3.0.2 +markupsafe==3.0.3 # via jinja2 -packaging==25.0 +packaging==26.2 # via # pydata-sphinx-theme # sphinx pydata-sphinx-theme==0.8.1 # via sphinx-book-theme -pygments==2.19.1 +pygments==2.20.0 # via sphinx -pyyaml==6.0.2 +pyyaml==6.0.3 # via sphinx-book-theme recommonmark==0.6.0 # via -r requirements/doc.in -requests==2.32.4 +requests==2.34.0 # via # sphinx # sphinxcontrib-images # sphinxcontrib-youtube snowballstemmer==3.0.1 # via sphinx -soupsieve==2.7 +soupsieve==2.8.3 # via beautifulsoup4 sphinx==4.2.0 # via @@ -100,9 +100,9 @@ sphinxcontrib-serializinghtml==1.1.5 # sphinx sphinxcontrib-youtube==1.3.0 # via -r requirements/doc.in -typing-extensions==4.14.0 +typing-extensions==4.15.0 # via beautifulsoup4 -urllib3==2.4.0 +urllib3==2.7.0 # via requests # The following packages are considered to be unsafe in a requirements file: diff --git a/requirements/pip-tools.txt b/requirements/pip-tools.txt index 3614ba69..bf7e12a9 100644 --- a/requirements/pip-tools.txt +++ b/requirements/pip-tools.txt @@ -1,26 +1,24 @@ # -# This file is autogenerated by pip-compile with Python 3.10 +# This file is autogenerated by pip-compile with Python 3.12 # by the following command: # # make upgrade # -build==1.2.2.post1 +build==1.5.0 # via pip-tools -click==8.2.1 +click==8.3.3 # via pip-tools -packaging==25.0 - # via build -pip-tools==7.4.1 - # via -r requirements/pip-tools.in -pyproject-hooks==1.2.0 +packaging==26.2 # via # build - # pip-tools -tomli==2.2.1 + # wheel +pip-tools==7.5.3 + # via -r requirements/pip-tools.in +pyproject-hooks==1.2.0 # via # build # pip-tools -wheel==0.45.1 +wheel==0.47.0 # via pip-tools # The following packages are considered to be unsafe in a requirements file: From 1aff76130449e81c313251ec68d9824abe7bc5c6 Mon Sep 17 00:00:00 2001 From: Mariagabriela Giorgianni Date: Tue, 12 May 2026 17:00:48 -0400 Subject: [PATCH 2/4] chore: unpin docs requirements and upgrade --- requirements/doc.in | 30 +++++++++++----------- requirements/doc.txt | 61 +++++++++++++++++++++++++------------------- 2 files changed, 50 insertions(+), 41 deletions(-) diff --git a/requirements/doc.in b/requirements/doc.in index 71a7541f..fcbb993d 100644 --- a/requirements/doc.in +++ b/requirements/doc.in @@ -1,15 +1,15 @@ -sphinx==4.2.0 -sphinx-book-theme==0.3.3 -recommonmark==0.6.0 -sphinxcontrib.images==0.9.4 -sphinx_panels==0.6.0 -sphinxcontrib.contentui==0.2.5 -sphinx_copybutton==0.5.0 -sphinxcontrib.mermaid==0.7.1 -sphinxcontrib-applehelp==1.0.4 -sphinxcontrib-devhelp==1.0.2 -sphinxcontrib-htmlhelp==2.0.1 -sphinxcontrib-qthelp==1.0.3 -sphinxcontrib-serializinghtml==1.1.5 -sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-youtube==1.3.0 +sphinx +sphinx-book-theme +recommonmark +sphinxcontrib.images +sphinx_panels +sphinxcontrib.contentui +sphinx_copybutton +sphinxcontrib.mermaid +sphinxcontrib-applehelp +sphinxcontrib-devhelp +sphinxcontrib-htmlhelp +sphinxcontrib-qthelp +sphinxcontrib-serializinghtml +sphinxcontrib-jsmath +sphinxcontrib-youtube diff --git a/requirements/doc.txt b/requirements/doc.txt index 76e39b7f..b727126d 100644 --- a/requirements/doc.txt +++ b/requirements/doc.txt @@ -4,10 +4,14 @@ # # make upgrade # -alabaster==0.7.16 +accessible-pygments==0.0.5 + # via pydata-sphinx-theme +alabaster==1.0.0 # via sphinx babel==2.18.0 - # via sphinx + # via + # pydata-sphinx-theme + # sphinx beautifulsoup4==4.14.3 # via pydata-sphinx-theme certifi==2026.4.22 @@ -16,7 +20,7 @@ charset-normalizer==3.4.7 # via requests commonmark==0.9.1 # via recommonmark -docutils==0.17.1 +docutils==0.22.4 # via # pydata-sphinx-theme # recommonmark @@ -27,31 +31,36 @@ idna==3.14 imagesize==2.0.0 # via sphinx jinja2==3.1.6 - # via sphinx + # via + # sphinx + # sphinxcontrib-mermaid markupsafe==3.0.3 # via jinja2 packaging==26.2 + # via sphinx +pydata-sphinx-theme==0.16.1 + # via sphinx-book-theme +pygments==2.20.0 # via + # accessible-pygments # pydata-sphinx-theme # sphinx -pydata-sphinx-theme==0.8.1 - # via sphinx-book-theme -pygments==2.20.0 - # via sphinx pyyaml==6.0.3 - # via sphinx-book-theme -recommonmark==0.6.0 + # via sphinxcontrib-mermaid +recommonmark==0.7.1 # via -r requirements/doc.in requests==2.34.0 # via # sphinx # sphinxcontrib-images # sphinxcontrib-youtube +roman-numerals==4.1.0 + # via sphinx snowballstemmer==3.0.1 # via sphinx soupsieve==2.8.3 # via beautifulsoup4 -sphinx==4.2.0 +sphinx==9.1.0 # via # -r requirements/doc.in # pydata-sphinx-theme @@ -61,49 +70,49 @@ sphinx==4.2.0 # sphinx-panels # sphinxcontrib-contentui # sphinxcontrib-images + # sphinxcontrib-mermaid # sphinxcontrib-youtube -sphinx-book-theme==0.3.3 +sphinx-book-theme==1.2.0 # via -r requirements/doc.in -sphinx-copybutton==0.5.0 +sphinx-copybutton==0.5.2 # via -r requirements/doc.in -sphinx-panels==0.6.0 +sphinx-panels==0.4.1 # via -r requirements/doc.in -sphinxcontrib-applehelp==1.0.4 +sphinxcontrib-applehelp==2.0.0 # via # -r requirements/doc.in # sphinx sphinxcontrib-contentui==0.2.5 # via -r requirements/doc.in -sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-devhelp==2.0.0 # via # -r requirements/doc.in # sphinx -sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-htmlhelp==2.1.0 # via # -r requirements/doc.in # sphinx -sphinxcontrib-images==0.9.4 +sphinxcontrib-images==1.0.1 # via -r requirements/doc.in sphinxcontrib-jsmath==1.0.1 # via # -r requirements/doc.in # sphinx -sphinxcontrib-mermaid==0.7.1 +sphinxcontrib-mermaid==2.0.2 # via -r requirements/doc.in -sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-qthelp==2.0.0 # via # -r requirements/doc.in # sphinx -sphinxcontrib-serializinghtml==1.1.5 +sphinxcontrib-serializinghtml==2.0.0 # via # -r requirements/doc.in # sphinx -sphinxcontrib-youtube==1.3.0 +sphinxcontrib-youtube==1.5.0 # via -r requirements/doc.in typing-extensions==4.15.0 - # via beautifulsoup4 + # via + # beautifulsoup4 + # pydata-sphinx-theme urllib3==2.7.0 # via requests - -# The following packages are considered to be unsafe in a requirements file: -# setuptools From a076fb2451010201f93fc368c1e1df1ff1d15f53 Mon Sep 17 00:00:00 2001 From: Mariagabriela Giorgianni Date: Wed, 13 May 2026 00:08:07 -0400 Subject: [PATCH 3/4] fix: update sphinx-book-theme options and sidebars for v1.x compatibility --- docs/source/conf.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index bc8cc459..09c5ddea 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -60,16 +60,15 @@ "repository_branch": "main", "path_to_docs": "source", "use_edit_page_button": True, - "logo_only": False, - "extra_navbar": extra_navbar_content, + "use_repository_button": True, + "use_issues_button": True, "home_page_in_toc": True, "show_navbar_depth": 1, - "use_repository_button": True, - "use_issues_button": True } -html_sidebars = {'**': ["sidebar-logo.html", "search-field.html", "sbt-sidebar-nav.html"]} - +html_sidebars = { + "**": ["navbar-logo.html", "search-field.html", "sbt-sidebar-nav.html"] +} # For custom styles images_config = { "default_image_width": "100%", From 0701db63d075f611d997c2ddb00d0830034044cd Mon Sep 17 00:00:00 2001 From: Mariagabriela Giorgianni Date: Wed, 13 May 2026 00:14:22 -0400 Subject: [PATCH 4/4] feat: Remove unnecessary internal Sphinx dependencies from requirements --- requirements/doc.in | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/requirements/doc.in b/requirements/doc.in index fcbb993d..3090039f 100644 --- a/requirements/doc.in +++ b/requirements/doc.in @@ -1,15 +1,9 @@ sphinx sphinx-book-theme -recommonmark +myst-parser sphinxcontrib.images -sphinx_panels +sphinx-design sphinxcontrib.contentui sphinx_copybutton sphinxcontrib.mermaid -sphinxcontrib-applehelp -sphinxcontrib-devhelp -sphinxcontrib-htmlhelp -sphinxcontrib-qthelp -sphinxcontrib-serializinghtml -sphinxcontrib-jsmath -sphinxcontrib-youtube +sphinxcontrib-youtube \ No newline at end of file