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 #1336

Conversation

ramonfigueiredo
Copy link
Collaborator

  • Update Sphinx version to 5.0.0 on docs/requirements.txt
  • Change docs/conf.py to use language = 'en'

- Update Sphinx version to 5.0.0 on docs/requirements.txt
- Change docs/conf.py to use language = 'en'
@ramonfigueiredo
Copy link
Collaborator Author

Update Sphinx version

This update addresses the failure in the "Test Documentation Build" workflow due to outdated Sphinx requirements.

The workflow was not compatible with Sphinx v4.3.1, as the minimum required version is now Sphinx v5.0.0. Additionally, Sphinx v5.0.0 mandates specifying a valid language setting, unlike the previous allowance for a None value.

Modifications made

  1. Updated the Sphinx version in docs/requirements.txt by replacing sphinx==4.3.1 with sphinx==5.0.0
  2. Altered docs/conf.py to set the documentation language explicitly. Changed language = None to language = 'en' to meet the new requirements of Sphinx v5.0.0

@bcipriano bcipriano merged commit b69156f into AcademySoftwareFoundation:master Jan 22, 2024
12 checks passed
carlosfelgarcia pushed a commit to carlosfelgarcia/OpenCue that referenced this pull request May 22, 2024
carlosfelgarcia pushed a commit to carlosfelgarcia/OpenCue that referenced this pull request May 22, 2024
@ramonfigueiredo ramonfigueiredo deleted the update_sphinx_version branch October 15, 2024 17:06
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