Skip to content

Update version constraints in requirements.txt files #48

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

Merged
merged 5 commits into from
Oct 29, 2024

Conversation

Mandrenkov
Copy link
Collaborator

@Mandrenkov Mandrenkov commented Oct 29, 2024

Context:

Building the XST website using the current requirements.txt files fails due to incompatible packages:

$ make docs
make -C doc html
Running Sphinx v4.5.0

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.
make[1]: *** [html] Error 2
make: *** [docs] Error 2

Description of the Change:

  1. Pinned some implicit requirements in doc/requirements.txt (to match the PennyLane Sphinx Theme).
  2. Bumped the pinned version of pillow to resolve some vulnerability alerts.
  3. Bumped the pinned version of black to resolve some vulnerability alerts.
  4. Updated the Python version used in the Formatting Check workflow to reflect (3).

Benefits:

  1. It is now possible to build the test documentation website locally using the provided requirements.txt files.
  2. There are no outstanding vulnerability alerts for the Xanadu Sphinx Theme.

Possible Drawbacks:
None.

Related GitHub Issues:
None.

@Mandrenkov Mandrenkov merged commit 19718f9 into master Oct 29, 2024
2 checks passed
@Mandrenkov Mandrenkov deleted the pin-implicit-doc-requirements branch October 29, 2024 21:10
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