Remove JQuery and update versions #668

choldgraf · 2023-01-05T13:18:23Z

This adds support for much of the latest versions of our dependencies, and also removes JQuery since it is now removed in the latest version of Sphinx.

Todo

MAINT: update testing against sphinx6, drop sphinx3 sphinx-thebe#57
Get the tests to pass
Fix the layout problem @AakashGfude mentioned in Remove JQuery and update versions #668 (comment)
Figure out why code cells have muted colors and revert or fix them
Extra ; after copyright symbol
Why are there no outputs on this page, make sure build is working correctly.
Double-check that the docs look correct

References

choldgraf · 2023-01-07T14:04:44Z

@AakashGfude could you have a look at this one?

mathbunnyru · 2023-01-07T14:22:35Z

Thanks!
The title is visible now, but it intersects with the search bar.

mathbunnyru · 2023-01-07T14:25:32Z

Also, may I ask you to build a new rc version when this is merged? I will try it out in our repo and will tell you if something goes wrong.

choldgraf · 2023-01-08T08:26:21Z

Hmm if you need this quickly it may need to be split into multiple PRs. This currently builds off of main for the pydata theme, so we'd need to wait for a release there.

mathbunnyru · 2023-01-08T08:37:42Z

No pressure here, we're not in a hurry at all :)
I just wanted to emphasize that after these changes, I will probably be quite happy with the new release and if needed, will do one more detailed comparison to see what's not working in our docs.

consideRatio · 2023-01-08T10:31:05Z

@mathbunnyru you can also install from the branch directly if you want to experiment i think!

I always end up googling how though, but i think @choldgraf may have a blogpost about it? 😅🥰

mathbunnyru · 2023-01-08T10:32:41Z

I actually tried it once locally and it didn't work for me on my m2 mac. I will try once again, when I have time :)

mathbunnyru · 2023-01-08T10:43:34Z

A few more differences I found with this PR (I compared it with the previous one):

It now adds ; after Copyright sign.

Code blocks highlighting looks different.
already merged pr: https://sphinx-book-theme--669.org.readthedocs.build/en/669/notebooks.html#code-blocks-and-image-outputs
this pr: https://sphinx-book-theme--668.org.readthedocs.build/en/668/notebooks.html#code-blocks-and-image-outputs

This page is not rendered properly at all - images and dataframes are missing, interactive part is also gone.

AakashGfude · 2023-01-08T12:10:22Z

Thanks! The title is visible now, but it intersects with the search bar.

Is the title purposefully made visible?

EDIT: Ok, got it, based on this issue: #672

AakashGfude · 2023-01-09T01:09:31Z

Something crazy happened in Sphinx extension styles page: https://sphinx-book-theme--668.org.readthedocs.build/en/668/reference/extensions.html

But the same problem is in the production page as well: https://sphinx-book-theme.readthedocs.io/en/latest/reference/extensions.html . I reckon the sphinx-tabs extension is interfering with something.

consideRatio · 2023-01-24T10:24:02Z

pyproject.toml

@@ -23,6 +23,7 @@ readme = "README.md"
 requires-python = ">=3.7"
 dependencies = [
  "sphinx>=4,<7",
+  "docutils==0.17.1", # docutils 0.18, 0.19 need a patch fix https://sourceforge.net/p/docutils/patches/195/


I love comments like these as they make us able to unpin and upgrade things.

I see sphinx-tabs was upper-bounded as well, can you add a comment be added about that also?

Thank you @AakashGfude for working this!!!!

pyproject.toml

Co-authored-by: Chris Holdgraf <choldgraf@gmail.com>

… into jquery

choldgraf · 2023-01-24T11:00:38Z

Another idea we had re: pinning versions was the following, curious what you think as well @consideRatio :

Instead of pinning versions in dependencies, add a check for the installed docutils versions, as well as the presence of sphinxcontrib-bibtex as a little Sphinx event function.
If docutils 0.18/0.19 is installed and there is sphinxcontrib-bibtex, raise a helpful warning that says "Hey you should either install docutils 0.17.1 and Sphinx 5, or wait until 0.20 is released".

I also opened an issue in sphinxcontrib-bibtex to see if they'd like the message in there, but it might be easier to do it here in the short term:

Check for docutils 0.18 and 0.19 and raise a helpful warning if it is installed mcmtroffaes/sphinxcontrib-bibtex#322

consideRatio · 2023-01-24T11:46:40Z

I think its good if a package can declare what versions won't work in requirements directly, and ideally while avoiding placing upper bound that needs to be removed in the future. But, if one doesn't know in what release something is patched, one kind of have to. If we know it will be resolved in 0.20 but not in 0.18 and 0.19 etc, then I think this is what to go for if this works >=0.17,!=0.19.*,!=0.20.*

I didn't understand the options about providing messages @choldgraf, but I'd like to avoid digging into this further since I have many balls in the air atm.

AakashGfude · 2023-01-24T12:07:05Z

It now adds ; after Copyright sign.

this semicolon is coming from pydata: https://github.com/pydata/pydata-sphinx-theme/blob/main/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/copyright.html#L7. So, we need to fix it there.

AakashGfude · 2023-01-25T03:01:44Z

Why are there no outputs on this page, make sure build is working correctly.

The outputs are working now.

mmcky · 2023-01-31T00:54:44Z

Thanks @AakashGfude for your work on this. I did a review of the rendered docs pages as a second check and here are a few minor things I noticed:

A couple of cells have some highlighting in them that I am not sure where that comes from. Such as the one below that is highlighting the 3 and 4 in blue from https://sphinx-book-theme--668.org.readthedocs.build/en/668/contributing/tests.html

Where do these gray lines come from next to the math?

AakashGfude · 2023-01-31T00:55:38Z

@mmcky @choldgraf this build with sphinx5 and docutils0.17 works well with pydata-sphinx-theme==0.12.0 as well (the latest stable release). Should we just use that? It does not have issues like "Extra ; after copyright symbol" etc as well.

choldgraf · 2023-02-02T13:11:34Z

@AakashGfude I'd suggest using the pydata latest version, because it's going to release a new version very soon:

Release 0.13 plan pydata/pydata-sphinx-theme#1109 is the issue to track

Do those issues show up there as well?

choldgraf · 2023-02-03T20:37:16Z

FYI - the pydata-sphinx-theme has a release candidate out! Check it out here:

https://github.com/pydata/pydata-sphinx-theme/releases/tag/v0.13.0rc1

@AakashGfude I see what you were saying about the missing ; not being present on 0.12, but being present on 0.13. I guess it's a question of whether we want to create another version bump w/ breaking changes relatively quickly after the next release. It seems sub-optimal, but I think if you really wanna get this one out the door, I'm fine just going for it and fixing up bugs in another PR.

choldgraf

OK following @AakashGfude's advice I think we should just merge this one, since it is already complex enough and make a clear improvement over our current situation. We will still need to update this theme again when the pydata theme releases once more, but I think that will be easier in a targeted PR.

I think there may also be some lingering UX issues that @mmcky , but could we confirm that they are present on our docs, and open issues to track them moving forward?

Many thanks @AakashGfude for all of your help on this one

AakashGfude · 2023-02-06T00:14:15Z

Thanks @choldgraf, I will update the version in a new PR once 0.13 Is released and reiterate if UX issues. Hopefully, should not be a lot.

sphinx-book-theme 1.x apparently has an undocumented breaking change in executablebooks/sphinx-book-theme#668 -- `logo_only` is no longer supported, and instead there is a `logo` option that I haven't looked into. I'm not sure what we want, but I'd rather unbreak and move on so that we at least don't have a broken docs build.

…ays fixed (#355) The output of python-library had a number of lint, quality, and test failures. This commit 1) fixes all of those failures, and 2) ensures that we have test coverage of those quality checks so that we don't regress in the future. Fixes to quality checks and unit tests: - Don't try to pylint manage.py in base template, since not all of them have one, and this causes a quality check failure for python-library. Simply removing the explicit reference is fine, since it's already covered by `*.py`. - Add a placeholder test so pytest will succeed for python-library. (It fails if there are no tests.) This placeholder test is marked to be skipped, which will hopefully stand out a bit in the resulting repo's test runs. - Move doc theme overrides CSS to base template (deleting from layered cookiecutters). There's a line in python-template's doc config that expects a _static dir (`html_static_path = ['_static']`) but there's no dir in the base, so docs build breaks for python-library (which did not have a copy of the CSS in a _static dir). Moving the CSS to the base fixes this so all cookiecutters can use it. - Remove `logo_only` from base docs config, as it was breaking the docs build for python-library. - sphinx-book-theme 1.x apparently has an undocumented breaking change in executablebooks/sphinx-book-theme#668 -- `logo_only` is no longer supported, and instead there is a `logo` option that I haven't looked into. I'm not sure what we want, but I'd rather unbreak and move on so that we at least don't have a broken docs build. - Prevent duplicate target error in various READMEs. - The "Getting Help" section header creates an implicit duplicate target that conflicts with the `_Getting Help:` reference. Rather than doing something more complicated, just inline the link. (This required using a double-underscore link to make it anonymous, otherwise you *still* get an implicit target!) - But also this "getting started" text was copied into the cookiecutter readmes, which are *instructions* for using the cookiecutters, not used in the template output. This duplicates the root readme in the repo, so I removed that text from those readmes. (Same for in the repo's own readme.) Other improvements: - Simplify python-library's `test_upgrade` and `test_quality` unit tests to just be a single call to `make upgrade requirements test-all`. This allows us to exercise the cookiercutter's Makefile and run all of its quality checks without reproducing the full list of checks in test code. (I haven't tackled the other cookiecutters yet, since some of them actually have test failures if you try to use this approach, or don't yet have a `make test-all` or equivalent.) - Include the docs build and validation in python-library's unit tests. - Update django-app's placeholder test to match the skipped one in cookiecutter-python-library. - Remove deprecated `--recursive` arg from isort calls. (Redundant in isort 5+ and causes a warning.) Not related to python-library cc tests, but easy fix.

choldgraf added 2 commits January 5, 2023 13:01

Remove JQuery and update versions

3f5708a

Merge branch 'master' into jquery

b8117aa

choldgraf mentioned this pull request Jan 5, 2023

Release v1.0.0 when we drop JQuery and add Bootstrap 5 #670

Open

4 tasks

choldgraf added 2 commits January 6, 2023 22:21

Merge commit

0615425

Fixing more configuration options

b0e6b52

choldgraf marked this pull request as ready for review January 7, 2023 14:01

choldgraf requested a review from AakashGfude January 7, 2023 14:03

cell input style

717a765

mmcky mentioned this pull request Jan 23, 2023

UPGRADE: myst-nb and many other dependencies jupyter-book/jupyter-book#1842

Merged

26 tasks

updating docutils

336a44d

consideRatio reviewed Jan 24, 2023

View reviewed changes

choldgraf commented Jan 24, 2023

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

choldgraf commented Jan 24, 2023

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

AakashGfude and others added 3 commits January 24, 2023 21:28

Update pyproject.toml

41be5dc

Co-authored-by: Chris Holdgraf <choldgraf@gmail.com>

comment update

b7458b3

Merge branch 'jquery' of https://github.com/choldgraf/sphinx-book-theme…

8e19c7d

… into jquery

AakashGfude force-pushed the jquery branch from 86889bd to 8e19c7d Compare January 25, 2023 01:27

AakashGfude added 3 commits January 25, 2023 12:32

pydata-latest release

81b60d4

limiting sphinx6 to the test

a7d8943

actually we dont need to limit sphinx in ci i think

42a04a5

AakashGfude added 2 commits January 25, 2023 14:54

hide input/output/cell style

5cf5fa3

margin docutils style

5da6240

choldgraf mentioned this pull request Feb 2, 2023

ENH: Update and refactor for latest book theme 2i2c-org/sphinx-2i2c-theme#14

Merged

3 tasks

choldgraf commented Feb 4, 2023

View reviewed changes

choldgraf merged commit 0b62420 into executablebooks:master Feb 4, 2023

choldgraf deleted the jquery branch February 4, 2023 08:07

timmc-edx mentioned this pull request Jun 21, 2023

fix: Fix all test/quality failures in python-library and ensure it stays fixed openedx/edx-cookiecutters#355

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove JQuery and update versions #668

Remove JQuery and update versions #668

choldgraf commented Jan 5, 2023 •

edited by AakashGfude

Loading

choldgraf commented Jan 7, 2023

mathbunnyru commented Jan 7, 2023

mathbunnyru commented Jan 7, 2023

choldgraf commented Jan 8, 2023

mathbunnyru commented Jan 8, 2023

consideRatio commented Jan 8, 2023

mathbunnyru commented Jan 8, 2023

mathbunnyru commented Jan 8, 2023 •

edited

Loading

AakashGfude commented Jan 8, 2023 •

edited

Loading

AakashGfude commented Jan 9, 2023

consideRatio Jan 24, 2023

consideRatio Jan 24, 2023

choldgraf commented Jan 24, 2023

consideRatio commented Jan 24, 2023

AakashGfude commented Jan 24, 2023

AakashGfude commented Jan 25, 2023

mmcky commented Jan 31, 2023 •

edited

Loading

AakashGfude commented Jan 31, 2023 •

edited

Loading

choldgraf commented Feb 2, 2023

choldgraf commented Feb 3, 2023 •

edited

Loading

choldgraf left a comment •

edited

Loading

AakashGfude commented Feb 6, 2023

Remove JQuery and update versions #668

Remove JQuery and update versions #668

Conversation

choldgraf commented Jan 5, 2023 • edited by AakashGfude Loading

Todo

References

choldgraf commented Jan 7, 2023

mathbunnyru commented Jan 7, 2023

mathbunnyru commented Jan 7, 2023

choldgraf commented Jan 8, 2023

mathbunnyru commented Jan 8, 2023

consideRatio commented Jan 8, 2023

mathbunnyru commented Jan 8, 2023

mathbunnyru commented Jan 8, 2023 • edited Loading

AakashGfude commented Jan 8, 2023 • edited Loading

AakashGfude commented Jan 9, 2023

consideRatio Jan 24, 2023

Choose a reason for hiding this comment

consideRatio Jan 24, 2023

Choose a reason for hiding this comment

choldgraf commented Jan 24, 2023

consideRatio commented Jan 24, 2023

AakashGfude commented Jan 24, 2023

AakashGfude commented Jan 25, 2023

mmcky commented Jan 31, 2023 • edited Loading

AakashGfude commented Jan 31, 2023 • edited Loading

choldgraf commented Feb 2, 2023

choldgraf commented Feb 3, 2023 • edited Loading

choldgraf left a comment • edited Loading

Choose a reason for hiding this comment

AakashGfude commented Feb 6, 2023

choldgraf commented Jan 5, 2023 •

edited by AakashGfude

Loading

mathbunnyru commented Jan 8, 2023 •

edited

Loading

AakashGfude commented Jan 8, 2023 •

edited

Loading

mmcky commented Jan 31, 2023 •

edited

Loading

AakashGfude commented Jan 31, 2023 •

edited

Loading

choldgraf commented Feb 3, 2023 •

edited

Loading

choldgraf left a comment •

edited

Loading