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

Upgrade sphinx version #8782

Closed
wants to merge 3 commits into from
Closed

Upgrade sphinx version #8782

wants to merge 3 commits into from

Conversation

DelazJ
Copy link
Collaborator

@DelazJ DelazJ commented Jan 15, 2024

With Sphinx 4.x being more and more deprecated, we need to either pin our dependencies or upgrade (see qgis/QGIS-Website#1135 (comment)). This PR proposes to upgrade to a more recent Sphinx version (pinned at 7.2.6) with a unpinned sphinx-rtd-theme.
While upgrading, I faced some other issues with setting the locale (see sphinx-doc/sphinx#11739) and this PR tries to fix them (at least for the github actions). Basically from what I could find, you need to locally set the LC_ALL locale env to C.UTF-8 but I'm not comfortable with this kind of things and:

  • it looks to me like a workaround
  • on a local build, people have to set that variable: what is its scope actually? Would that "break" anything on their system? Is it possible to set that env only in the venv they are running? <-- I'm asking this because we need to instruct people that new requirement.
  • I can't find how to do the same on macOS and I didn't test Windows. So if you know a better way to solve that locale issue on all platforms, ...

@DelazJ
Copy link
Collaborator Author

DelazJ commented Jan 16, 2024

Let's do the changes in the website requirements file

@DelazJ DelazJ closed this Jan 16, 2024
@DelazJ DelazJ deleted the UpgradeSphinx branch February 5, 2024 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backend build/doctest When the build fails and it's not your fault...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant