From bbdfe27c3f40f584474236d35fbeb00175bce564 Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Tue, 3 Aug 2021 13:28:17 +0200 Subject: [PATCH 01/12] Update Sphinx to include v4 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 6b69fce7..1c4224fa 100644 --- a/setup.py +++ b/setup.py @@ -30,7 +30,7 @@ install_requires=[ "pyyaml", "docutils>=0.15", - "sphinx>=2,<4", + "sphinx>=3,<5", "click", "pydata-sphinx-theme~=0.6.0", "beautifulsoup4>=4.6.1,<5", From 6da8076afc6e003a1a9de62fb0fe54e8aea2c9f4 Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Tue, 3 Aug 2021 14:36:19 +0200 Subject: [PATCH 02/12] Fix logo for upgrade --- sphinx_book_theme/_templates/sidebar-logo.html | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/sphinx_book_theme/_templates/sidebar-logo.html b/sphinx_book_theme/_templates/sidebar-logo.html index a74a1f5a..a56680bc 100644 --- a/sphinx_book_theme/_templates/sidebar-logo.html +++ b/sphinx_book_theme/_templates/sidebar-logo.html @@ -1,7 +1,11 @@
{% if logo %} - + + {% set logo_url=logo %} + {% endif %} + {% if logo_url %} + {% endif %} {% if docstitle and not theme_logo_only %}

{{ docstitle }}

From 59ab648055c7e1bc28ed4ce3521977044c338bc0 Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Fri, 6 Aug 2021 09:10:56 -0700 Subject: [PATCH 03/12] Tests use Sphinx 4 --- setup.py | 31 ++++++++++++++++--------------- tox.ini | 4 ++-- 2 files changed, 18 insertions(+), 17 deletions(-) diff --git a/setup.py b/setup.py index 1c4224fa..7a37f88f 100644 --- a/setup.py +++ b/setup.py @@ -28,39 +28,40 @@ license="BSD", packages=find_packages(), install_requires=[ - "pyyaml", - "docutils>=0.15", - "sphinx>=3,<5", - "click", - "pydata-sphinx-theme~=0.6.0", "beautifulsoup4>=4.6.1,<5", + "click", + "docutils>=0.15", 'importlib-resources>=3.0,<3.5; python_version < "3.7"', + "pydata-sphinx-theme~=0.6.0", + "pyyaml", + "sphinx>=3,<5", ], extras_require={ "code_style": ["pre-commit~=2.7.0"], "sphinx": [ + "ablog~=0.10.13", "folium", - "numpy", - "matplotlib", "ipywidgets", - "pandas", - "nbclient", + "matplotlib", "myst-nb~=0.11.1", - "sphinx-togglebutton>=0.2.1", - "sphinx-copybutton", + "nbclient", + "numpy", + "pandas", "plotly", - "sphinxcontrib-bibtex~=2.2", + "sphinx~=4.0", # Force Sphinx to be the latest version + "sphinx-copybutton", "sphinx-thebe", - "ablog~=0.10.13", + "sphinx-togglebutton>=0.2.1", + "sphinxcontrib-bibtex~=2.2", "sphinxext-opengraph", ], "testing": [ - "myst_nb~=0.11.1", - "sphinx_thebe", "coverage", + "myst_nb~=0.11.1", "pytest~=6.0.1", "pytest-cov", "pytest-regressions~=2.0.1", + "sphinx_thebe", ], "live-dev": ["sphinx-autobuild", "web-compile~=0.2.1"], }, diff --git a/tox.ini b/tox.ini index 9a341539..4040f990 100644 --- a/tox.ini +++ b/tox.ini @@ -16,11 +16,11 @@ envlist = py37-sphinx3 [testenv] usedevelop=true -[testenv:py{36,37,38}-sphinx{2,3}] +[testenv:py{36,37,38}-sphinx{3,4}] extras = testing deps = - sphinx2: sphinx>=2,<3 sphinx3: sphinx>=3,<4 + sphinx4: sphinx>=4,<5 commands = pytest {posargs} [testenv:py{36,37,38}-pre-commit] From 215ddda7a849b10c4a9fb95b0bb97b443bc28777 Mon Sep 17 00:00:00 2001 From: mmcky Date: Thu, 2 Sep 2021 20:48:01 +1000 Subject: [PATCH 04/12] upgrade myst-nb to 0.13 --- setup.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/setup.py b/setup.py index 079c82fe..9a88abb7 100644 --- a/setup.py +++ b/setup.py @@ -30,7 +30,7 @@ install_requires=[ "beautifulsoup4>=4.6.1,<5", "click", - "docutils>=0.15", + "docutils>=0.15,<0.18", 'importlib-resources>=3.0,<3.5; python_version < "3.7"', "pydata-sphinx-theme~=0.6.0", "pyyaml", @@ -44,7 +44,7 @@ "folium", "numpy", "matplotlib", - "myst-nb~=0.11.1", + "myst-nb~=0.13", "nbclient", "pandas", "plotly", @@ -58,7 +58,7 @@ ], "testing": [ "coverage", - "myst_nb~=0.11.1", + "myst_nb~=0.13", "pytest~=6.0.1", "pytest-cov", "pytest-regressions~=2.0.1", From 7bdc1c5ca22b3a71a84b0484cad687a5b6b6a00f Mon Sep 17 00:00:00 2001 From: mmcky Date: Thu, 2 Sep 2021 20:49:46 +1000 Subject: [PATCH 05/12] Revert "upgrade myst-nb to 0.13" This reverts commit 215ddda7a849b10c4a9fb95b0bb97b443bc28777. --- setup.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/setup.py b/setup.py index 9a88abb7..079c82fe 100644 --- a/setup.py +++ b/setup.py @@ -30,7 +30,7 @@ install_requires=[ "beautifulsoup4>=4.6.1,<5", "click", - "docutils>=0.15,<0.18", + "docutils>=0.15", 'importlib-resources>=3.0,<3.5; python_version < "3.7"', "pydata-sphinx-theme~=0.6.0", "pyyaml", @@ -44,7 +44,7 @@ "folium", "numpy", "matplotlib", - "myst-nb~=0.13", + "myst-nb~=0.11.1", "nbclient", "pandas", "plotly", @@ -58,7 +58,7 @@ ], "testing": [ "coverage", - "myst_nb~=0.13", + "myst_nb~=0.11.1", "pytest~=6.0.1", "pytest-cov", "pytest-regressions~=2.0.1", From 4cab78d14498fca1fdee6a7751a0b9986cc6e571 Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Thu, 2 Sep 2021 12:10:17 -0700 Subject: [PATCH 06/12] Update MyST NB and click --- setup.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/setup.py b/setup.py index 079c82fe..52a4ee74 100644 --- a/setup.py +++ b/setup.py @@ -29,7 +29,7 @@ packages=find_packages(), install_requires=[ "beautifulsoup4>=4.6.1,<5", - "click", + "click~=7.1", "docutils>=0.15", 'importlib-resources>=3.0,<3.5; python_version < "3.7"', "pydata-sphinx-theme~=0.6.0", @@ -44,7 +44,7 @@ "folium", "numpy", "matplotlib", - "myst-nb~=0.11.1", + "myst-nb~=0.13", "nbclient", "pandas", "plotly", @@ -58,7 +58,7 @@ ], "testing": [ "coverage", - "myst_nb~=0.11.1", + "myst_nb~=0.13", "pytest~=6.0.1", "pytest-cov", "pytest-regressions~=2.0.1", From 8b7f5b4927daa1e77bb90595c339908ff0999ea9 Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Thu, 2 Sep 2021 12:12:27 -0700 Subject: [PATCH 07/12] Update setup.py --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 52a4ee74..f336347f 100644 --- a/setup.py +++ b/setup.py @@ -30,7 +30,7 @@ install_requires=[ "beautifulsoup4>=4.6.1,<5", "click~=7.1", - "docutils>=0.15", + "docutils>=0.15,<0.18", 'importlib-resources>=3.0,<3.5; python_version < "3.7"', "pydata-sphinx-theme~=0.6.0", "pyyaml", From 48b755685e77e030cce8a1791b3d8feeb652b194 Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Thu, 2 Sep 2021 12:35:06 -0700 Subject: [PATCH 08/12] Fixing import for Margin directive --- docs/conf.py | 2 +- sphinx_book_theme/__init__.py | 4 ++-- tests/test_build/test_build_book.html | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 4817e87f..774af612 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -60,7 +60,7 @@ # "linkify", # "substitution", ] -myst_url_schemes = ("http", "https", "mailto") +myst_url_schemes = ["http", "https", "mailto"] # -- Options for HTML output ------------------------------------------------- diff --git a/sphinx_book_theme/__init__.py b/sphinx_book_theme/__init__.py index 83d6ef92..4b55e47c 100644 --- a/sphinx_book_theme/__init__.py +++ b/sphinx_book_theme/__init__.py @@ -9,7 +9,7 @@ import importlib_resources as resources from bs4 import BeautifulSoup as bs -from docutils.parsers.rst import directives +from docutils.parsers.rst.directives.body import Sidebar from docutils import nodes from sphinx.application import Sphinx from sphinx.locale import get_translation @@ -254,7 +254,7 @@ def _string_or_bool(var): return var is None -class Margin(directives.body.Sidebar): +class Margin(Sidebar): """Goes in the margin to the right of the page.""" optional_arguments = 1 diff --git a/tests/test_build/test_build_book.html b/tests/test_build/test_build_book.html index 4c68ac8e..1f59c340 100644 --- a/tests/test_build/test_build_book.html +++ b/tests/test_build/test_build_book.html @@ -13,7 +13,7 @@