Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update sphinx version for CI to pass on main #854

Merged
merged 6 commits into from
Jan 15, 2024
Merged

Conversation

Abishalini
Copy link
Contributor

Currently, the htmlproofer and upload_site_artifacts CI jobs are failing on main due to

Sphinx version error:
The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.

requirements.txt Outdated
@@ -1,6 +1,6 @@
pip
docutils==0.16
sphinx==4.3.2
sphinx
Copy link
Contributor

@sea-bass sea-bass Jan 15, 2024

Choose a reason for hiding this comment

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

To minimize breakages, do you maybe want to specify a version after all?

The one that was downloaded was 7.2.6 according to https://github.com/ros-planning/moveit2_tutorials/actions/runs/7531539359/job/20500319203?pr=854#step:4:82

You can also use something like sphinx>=5.0.0 if you just want to skirt around the immediate error but give users wiggle room when building locally.

Generally for these things it's good for the pip requirements to be pinned to actual versions and for any updates to be deliberate.

@sea-bass
Copy link
Contributor

Oh also this didn't seem to fix the issue, seems like it's launching with Sphinx 4.5.0 : https://github.com/ros-planning/moveit2_tutorials/actions/runs/7531539359/job/20500319203?pr=854#step:7:20320

@Abishalini
Copy link
Contributor Author

In the htmlproofer job, it is running Sphinx v5.3.0. The error now is

Warning, treated as error:
Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English).

In the upload_site_artifacts job, it is running Sphinx v4.3.2. Not sure what is going on here

@Abishalini
Copy link
Contributor Author

How is it decided which version of packages to use?

If v7.2 is downloaded, why does it use v5.3.0?

Collecting sphinx>=5.0.0 (from -r requirements.txt (line 3))
  Downloading sphinx-7.2.6-py3-none-any.whl.metadata (5.9 kB)

The lastest error in htmlproofer job is

Exception occurred:
  File "/usr/local/lib/python3.10/dist-packages/sphinx_tabs/tabs.py", line 341, in setup
    app.add_javascript(path)
AttributeError: 'Sphinx' object has no attribute 'add_javascript'

The attribute add_javscript is deprecated and the latest version of sphinx-tabs does not use it.

It looks like the latest version of sphinx-tabs is downloaded but not used?

Collecting sphinx-tabs (from -r requirements.txt (line 4))
  Downloading sphinx_tabs-3.4.4-py3-none-any.whl.metadata (6.3 kB)

@sea-bass
Copy link
Contributor

Copy link
Contributor

@sea-bass sea-bass left a comment

Choose a reason for hiding this comment

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

We'll need to rebuild the Docker images to get these other things passing, so just go for it.

@sea-bass sea-bass merged commit d38b9d6 into main Jan 15, 2024
7 of 9 checks passed
@sea-bass sea-bass deleted the pr-update-sphinx-version branch January 15, 2024 19:13
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.

2 participants