UPDATE: Sphinx v4.0.0 #364

choldgraf · 2021-08-03T11:30:07Z

This PR enables sphinx>4 to be supported

choldgraf · 2021-08-03T11:38:37Z

any reason not to just merge this @chrisjsewell ?

chrisjsewell · 2021-08-03T11:53:48Z

any reason not to just merge this @chrisjsewell ?

Yeh should be fine if it’s passing tests, although it’s always good to have a quick look at https://www.sphinx-doc.org/en/master/extdev/deprecated.html and think if anything applies here

choldgraf · 2021-08-03T12:37:34Z

good catch @chrisjsewell - logo is deprecated in favor of logo_url in V4, so I added a check for this and also noted when to remove it

chrisjsewell

@choldgraf I note that both the tests (https://github.com/executablebooks/sphinx-book-theme/pull/364/checks?check_run_id=3263717973) and document's build (https://readthedocs.org/projects/sphinx-book-theme/builds/14417635/) are still not being actually run with sphinx version 4.

So obviously this isn't yet testing compatibility with v4 😬 and we need to look what is still pinning to v3

choldgraf · 2021-08-06T16:07:11Z

@chrisjsewell ah OK lemme take a look at the test infra, still getting the hang of tox

choldgraf · 2021-08-06T16:11:41Z

Latest commit adds Sphinx 4 to the testing matrix and removes Sphinx 2. Also updates the dependencies to be alphabetical :-)

edit: argh ReadTheDocs is failing because MyST-NB doesn't yet support Sphinx 4, so this PR is blocked on executablebooks/MyST-NB#338

This reverts commit 215ddda.

mmcky · 2021-09-02T10:51:15Z

@choldgraf there are test failures when I upgrade to myst-nb~=0.13 for testing. I will look more into this tomorrow morning but have reverted the change for now -- might be due to docutils change.

setup.py

choldgraf · 2021-09-02T20:23:27Z

@mmcky I got all the tests passing :-) could you give a quick review?

mmcky

thanks for finishing this off @choldgraf looking good.

mmcky · 2021-09-02T22:41:32Z

docs/conf.py

@@ -60,7 +60,7 @@
    # "linkify",
    # "substitution",
 ]
-myst_url_schemes = ("http", "https", "mailto")
+myst_url_schemes = ["http", "https", "mailto"]


@choldgraf this is now the default in myst-parser so we can remove this now.

mmcky · 2021-09-02T22:47:35Z

sphinx_book_theme/_templates/sidebar-logo.html

@@ -1,7 +1,11 @@
 <div class="navbar-brand-box">
    <a class="navbar-brand text-wrap" href="{{ pathto('index') }}">
      {% if logo %}
-      <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
+        <!-- `logo` is deprecated in Sphinx 4.0, so remove this when we stop supporting 3 -->


@choldgraf good find! Thanks.

Oh cool it looks like there are html_logo and latex_logo now

https://www.sphinx-doc.org/en/master/usage/configuration.html?highlight=logo#confval-html_logo

This is something we will need to manage in jupyter-book to issue a depcration notice for logo in jupyter-book/jupyter-book#1438

we may not need to deprecate it if we are managing it under the hood though!

OK -- if html or latex isn't specified use logo -- I see where you are going

mmcky · 2021-09-02T22:52:23Z

https://www.sphinx-doc.org/en/master/extdev/deprecated.html

@chrisjsewell that is a great link. Thanks 👍

mmcky · 2021-09-02T23:03:08Z

@choldgraf this fails under sphinx3 against a fixture so I will add in sphinx3 and sphinx4 fixtures and will run tests againts both major sphinx versions

chrisjsewell · 2021-09-02T23:21:30Z

Guys, FYI it is going to be a bit more of change than this, to support docutils 0.17.

It now uses a bunch of semantic HTML tags: <main>, <section>, <header>, <footer>, <aside>, <figure>, and <figcaption>, instead of e.g. <div class="section"> (see sphinx-doc/sphinx#9001)

It will break lots of current CSS, like:

sphinx-book-theme/src/scss/_page.scss

Line 66 in 4350696

> div > div > div.section, .prev-next-bottom {

choldgraf · 2021-09-02T23:27:34Z

@chrisjsewell I think this means that we will need to choose to only support docutils 0.17 and up, or else we're going to have to maintain a bunch of CSS that is meant for pre/post 0.17, right?

For some reason our RTD builds are using docutils ~ 0.16: https://readthedocs.org/projects/sphinx-book-theme/builds/14623897/

that's why we weren't catching the CSS regressions

mmcky · 2021-09-02T23:37:32Z

ah docutils==0.17!

Alternatively we could keep docutils>=0.15,<0.17 and then upgrade docutils to support 0.17 separately?

I don't think there is anything in the stack that uses 0.17 as a minimum yet.

chrisjsewell · 2021-09-02T23:38:55Z

I think this means that we will need to choose to only support docutils 0.17 and up, or else we're going to have to maintain a bunch of CSS that is meant for pre/post 0.17, right?

I guess firstly I would have a look at what other themes are doing about this, and obviously we likely also require pydata to make updates as well, so at least for now we will likely have to pin to <0.17

You can possibly do e.g. div.section,section. to support both; don't know if there is anywhere that could cause issues

for more information, see https://pre-commit.ci

…phinx-book-theme into sphinx-4

mmcky · 2021-09-02T23:52:19Z

Opened an issue to track docutils==0.17 support #392

mmcky · 2021-09-03T00:01:43Z

@choldgraf just updated the branch protection rules. I learnt about this yesterday from @chrisjsewell :-)

Update: Hot tip -- helps to hit save 👍

The rules were updated to include the sphinx versions in the testing matrix

choldgraf · 2021-09-03T00:35:19Z

As long as we are not creating version conflicts with other parts of the stack then that works for me

mmcky · 2021-09-03T01:41:57Z

As long as we are not creating version conflicts with other parts of the stack then that works for me

I have been copying myst-parser which is docutils>=0.15,<0.18 so sphinx-book-theme would impose 0.16 in preference to 0.17 but as I understand it should be able to resolve in the stack given the ranges. But maybe we should add #392 as a priority item.

choldgraf · 2021-09-07T22:38:42Z

@mmcky anything left of this one or are you just waiting for someone to approve?

mmcky · 2021-09-08T00:01:13Z

@choldgraf just waiting on an approval I think this is ready to 🚢

choldgraf · 2021-09-15T23:42:13Z

ok let's ship this one so that we aren't holding everybody back from upgrading to Sphinx 4 :-)

THANK YOU @mmcky 🎉 and @chrisjsewell for spotting the HTML bugs that we were going to run into w/ docutils

Update Sphinx to include v4

bbdfe27

choldgraf requested a review from chrisjsewell August 3, 2021 11:38

Fix logo for upgrade

6da8076

chrisjsewell mentioned this pull request Aug 3, 2021

RTD render doesn't show a .svg logo? #365

Closed

Merge branch 'master' into sphinx-4

9e983da

chrisjsewell requested changes Aug 6, 2021

View reviewed changes

Tests use Sphinx 4

59ab648

choldgraf force-pushed the sphinx-4 branch from a752430 to 59ab648 Compare August 6, 2021 16:12

choldgraf mentioned this pull request Aug 25, 2021

UPGRADE: MyST-NB ~=0.13, Support Sphinx 4 jupyter-book/jupyter-book#1438

Closed

6 tasks

mmcky and others added 3 commits September 2, 2021 20:45

Merge branch 'master' into sphinx-4

9c07d6c

upgrade myst-nb to 0.13

215ddda

Revert "upgrade myst-nb to 0.13"

7bdc1c5

This reverts commit 215ddda.

Update MyST NB and click

4cab78d

choldgraf commented Sep 2, 2021

View reviewed changes

setup.py Outdated Show resolved Hide resolved

Update setup.py

8b7f5b4

choldgraf force-pushed the sphinx-4 branch from 853af7c to c53d7d2 Compare September 2, 2021 19:44

Fixing import for Margin directive

48b7556

choldgraf force-pushed the sphinx-4 branch from c53d7d2 to 48b7556 Compare September 2, 2021 20:11

choldgraf requested a review from mmcky September 2, 2021 20:23

mmcky previously approved these changes Sep 2, 2021

View reviewed changes

remove default from myst-parser settings

61392b9

mmcky dismissed their stale review via 61392b9 September 2, 2021 22:51

mmcky and others added 4 commits September 3, 2021 09:43

add in sphinx3 and sphinx4 fixture tracking and update CI

ba3aa83

[pre-commit.ci] auto fixes from pre-commit.com hooks

e188ee1

for more information, see https://pre-commit.ci

Exclude docutils==0.17 for now

797523b

Merge branch 'sphinx-4' of https://github.com/ExecutableBookProject/s…

9b8f93f

…phinx-book-theme into sphinx-4

mmcky requested review from mmcky and chrisjsewell September 2, 2021 23:57

mmcky approved these changes Sep 2, 2021

View reviewed changes

mmcky mentioned this pull request Sep 7, 2021

IMPROVE: Support Sphinx v4 jupyter-book/jupyter-book#1448

Merged

8 tasks

Merge branch 'master' into sphinx-4

f473b30

pbauer added a commit to plone/training that referenced this pull request Sep 8, 2021

pinn Sphinx < 4 until executablebooks/sphinx-book-theme#364 is merged

751c47e

choldgraf merged commit 28358bb into master Sep 15, 2021

choldgraf deleted the sphinx-4 branch September 15, 2021 23:43

chrisjsewell mentioned this pull request Jan 10, 2022

🔧 MAINTAIN: Remove click dependency #457

Merged

anjackson mentioned this pull request May 3, 2023

v0.13 has broken utterances jupyter-book/jupyter-book#1762

Open

goodboy mentioned this pull request Aug 3, 2023

Revamp DOCS, fo realz goodboy/tractor#157

Open

13 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

UPDATE: Sphinx v4.0.0 #364

UPDATE: Sphinx v4.0.0 #364

choldgraf commented Aug 3, 2021 •

edited by mmcky

Loading

choldgraf commented Aug 3, 2021

chrisjsewell commented Aug 3, 2021

choldgraf commented Aug 3, 2021

chrisjsewell left a comment

choldgraf commented Aug 6, 2021

choldgraf commented Aug 6, 2021 •

edited

Loading

mmcky commented Sep 2, 2021 •

edited

Loading

choldgraf commented Sep 2, 2021

mmcky left a comment

mmcky Sep 2, 2021

mmcky Sep 2, 2021

mmcky Sep 2, 2021

choldgraf Sep 2, 2021

mmcky Sep 2, 2021

mmcky commented Sep 2, 2021

mmcky commented Sep 2, 2021 •

edited

Loading

chrisjsewell commented Sep 2, 2021 •

edited

Loading

choldgraf commented Sep 2, 2021 •

edited

Loading

mmcky commented Sep 2, 2021

chrisjsewell commented Sep 2, 2021

mmcky commented Sep 2, 2021 •

edited

Loading

mmcky commented Sep 3, 2021 •

edited

Loading

choldgraf commented Sep 3, 2021

mmcky commented Sep 3, 2021 •

edited

Loading

choldgraf commented Sep 7, 2021

mmcky commented Sep 8, 2021

choldgraf commented Sep 15, 2021 •

edited

Loading

UPDATE: Sphinx v4.0.0 #364

UPDATE: Sphinx v4.0.0 #364

Conversation

choldgraf commented Aug 3, 2021 • edited by mmcky Loading

choldgraf commented Aug 3, 2021

chrisjsewell commented Aug 3, 2021

choldgraf commented Aug 3, 2021

chrisjsewell left a comment

Choose a reason for hiding this comment

choldgraf commented Aug 6, 2021

choldgraf commented Aug 6, 2021 • edited Loading

mmcky commented Sep 2, 2021 • edited Loading

choldgraf commented Sep 2, 2021

mmcky left a comment

Choose a reason for hiding this comment

mmcky Sep 2, 2021

Choose a reason for hiding this comment

mmcky Sep 2, 2021

Choose a reason for hiding this comment

mmcky Sep 2, 2021

Choose a reason for hiding this comment

choldgraf Sep 2, 2021

Choose a reason for hiding this comment

mmcky Sep 2, 2021

Choose a reason for hiding this comment

mmcky commented Sep 2, 2021

mmcky commented Sep 2, 2021 • edited Loading

chrisjsewell commented Sep 2, 2021 • edited Loading

choldgraf commented Sep 2, 2021 • edited Loading

mmcky commented Sep 2, 2021

chrisjsewell commented Sep 2, 2021

mmcky commented Sep 2, 2021 • edited Loading

mmcky commented Sep 3, 2021 • edited Loading

choldgraf commented Sep 3, 2021

mmcky commented Sep 3, 2021 • edited Loading

choldgraf commented Sep 7, 2021

mmcky commented Sep 8, 2021

choldgraf commented Sep 15, 2021 • edited Loading

choldgraf commented Aug 3, 2021 •

edited by mmcky

Loading

choldgraf commented Aug 6, 2021 •

edited

Loading

mmcky commented Sep 2, 2021 •

edited

Loading

mmcky commented Sep 2, 2021 •

edited

Loading

chrisjsewell commented Sep 2, 2021 •

edited

Loading

choldgraf commented Sep 2, 2021 •

edited

Loading

mmcky commented Sep 2, 2021 •

edited

Loading

mmcky commented Sep 3, 2021 •

edited

Loading

mmcky commented Sep 3, 2021 •

edited

Loading

choldgraf commented Sep 15, 2021 •

edited

Loading