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

Docs fail to build #30

Closed
mjaquiery opened this issue Oct 14, 2024 · 0 comments · Fixed by #31
Closed

Docs fail to build #30

mjaquiery opened this issue Oct 14, 2024 · 0 comments · Fixed by #31
Assignees
Labels
bug Something isn't working

Comments

@mjaquiery
Copy link
Collaborator

Describe the bug
The Sphinx docs are failing to build because the sphinxcontrib.images code hasn't been updated to work with Sphinx 8, and Sphinx 8 is now the current major release.

To Reproduce
Steps to reproduce the behavior:

  1. Update main branch to trigger a docs build
  2. Go to GH Actions
  3. See that Docs build has failed

Temporary fix
We can temporarily fix this by pinning Sphinx version to 7.4.7, which in turn requires using a pip install of Sphinx rather than an apt-get install.

Permanent fix
Once the PR to fix this in sphinxcontrib.images has been merged, we can update to Sphinx 8. #29

@mjaquiery mjaquiery added the bug Something isn't working label Oct 14, 2024
@mjaquiery mjaquiery moved this to In progress in Galv Bug Tracker Oct 14, 2024
@mjaquiery mjaquiery self-assigned this Oct 14, 2024
@mjaquiery mjaquiery linked a pull request Oct 14, 2024 that will close this issue
@github-project-automation github-project-automation bot moved this from In progress to Done in Galv Bug Tracker Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant