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

Updated dependency to sphinx 7.4.0, and enabled linkcheck testing. #444

Merged
merged 4 commits into from
Jul 15, 2024

Conversation

MicahGale
Copy link
Collaborator

Description

An upstream bug with Sphinx and linkcheck failing for PDFs with anchors has been resolved. This just requires a version of Sphinx with this fix, and requires linkcheck to pass.

Fixes #414

Checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works (if applicable)

@MicahGale MicahGale added the documentation Improvements or additions to documentation label Jul 15, 2024
@MicahGale MicahGale requested a review from tjlaboss July 15, 2024 14:02
@MicahGale MicahGale self-assigned this Jul 15, 2024
@MicahGale MicahGale linked an issue Jul 15, 2024 that may be closed by this pull request
@MicahGale
Copy link
Collaborator Author

This is failing because pip in GHA doesn't have the latest version of Sphinx. I assume that GHA python uses a GitHub clone of pypi. The version of Sphinx I need is less than 10 hours old. I'm thinking of trying these again in 24 hours and seeing if the cache is updated daily.

@MicahGale
Copy link
Collaborator Author

MicahGale commented Jul 15, 2024

The issue is actually that sphinx 7.4.0 doesn't support python 3.8. I think I will I just updated the build testing, and docs deploy to use a later version of python.

@tjlaboss
Copy link
Collaborator

Python 3.8 is due to reach its scheduled upstream end-of-life in October 2024.

@MicahGale
Copy link
Collaborator Author

Python 3.8 is due to reach its scheduled upstream end-of-life in October 2024.

Yep see #201. IMO: all supported versions of python will be supported for users, but only the latest version of python will be officially supported for dev. This change would move dev support from 3.8 to 3.9. I think this is fine as building docs is a "dev" task.

@MicahGale MicahGale merged commit 5d265a8 into develop Jul 15, 2024
14 checks passed
@MicahGale MicahGale deleted the 414-use-linktest-as-part-of-website-build branch July 15, 2024 22:28
@MicahGale MicahGale mentioned this pull request Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use linktest as part of website build
2 participants