Skip to content

Comments

update Sphinx to 3.5.4, jQuery to 3.5.1#7832

Merged
kcondon merged 2 commits intoIQSS:developfrom
uncch-rdmc:7233_update_sphinx_jquery
May 3, 2021
Merged

update Sphinx to 3.5.4, jQuery to 3.5.1#7832
kcondon merged 2 commits intoIQSS:developfrom
uncch-rdmc:7233_update_sphinx_jquery

Conversation

@donsizemore
Copy link
Contributor

What this PR does / why we need it: We've currently pegged Sphinx at 1.5.6 because upgrading broke search. This PR updates Sphinx and jQuery without breaking search (or at least, "it's working for me locally").

Which issue(s) this PR closes:

Closes #7233

Special notes for your reviewer: none

Suggestions on how to test this: make html

Does this PR introduce a user interface change? If mockups are available, please link/include them here: no

Is there a release notes update needed for this change?: no

Additional documentation: will need to upgrade Sphinx on the Jenkins nodes when the time comes, though this PR should allow us to start automatically building guide branches by pull request trigger in GitHub Actions.

@djbrooke
Copy link
Contributor

Thanks @donsizemore - this is great! We'll review.

Copy link
Contributor

@scolapasta scolapasta left a comment

Choose a reason for hiding this comment

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

One small comment on something you commented out; if there's reason to leave, just let me know and I can approve.

html_js_files = [
'js/jquery-3.4.1.min.js',
]
# this breaks $
Copy link
Contributor

Choose a reason for hiding this comment

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

should we consider just removing this, if it's not needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I commented out that setting and left it as pseudo-documentation in case anyone wondered why it was removed, and in case it needed to be put back in the future for whatever reason. Happy to remove it if you think I should.

Copy link
Contributor

Choose a reason for hiding this comment

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

I honestly don't know what it would need to be there for - we always have version control if we need, so I'd vote just remove.

@kcondon kcondon self-assigned this May 3, 2021
@kcondon kcondon merged commit 4a9ac4e into IQSS:develop May 3, 2021
@djbrooke djbrooke added this to the 5.5 milestone May 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support newer version of Sphinx so that Guides Search still works

4 participants