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

Specify language as 'en' instead of None #1059

Merged
merged 2 commits into from Jun 22, 2022

Conversation

jakirkham
Copy link
Member

Needed for Sphinx 5 compatibility. Should fix the following warning occurring in doc builds.

Invalid configuration value found: 'language = None'. Update your configuration to a valid langauge code. Falling back to 'en' (English).

xref: sphinx-doc/sphinx#10481

Needed for Sphinx 5 compatibility. Should fix warning during doc build.
@jakirkham jakirkham requested a review from a team as a code owner June 21, 2022 22:16
@github-actions github-actions bot added the Python Related to RMM Python API label Jun 21, 2022
@jakirkham jakirkham added bug Something isn't working non-breaking Non-breaking change labels Jun 21, 2022
@bdice
Copy link
Contributor

bdice commented Jun 21, 2022

@jakirkham Do we want to remove the declaration of language entirely, rather than set it to "en"? This comment seems to suggest deleting the variable, and several linked PRs to other projects took that approach. sphinx-doc/sphinx#10474 (comment)

@jakirkham
Copy link
Member Author

Interpret that comment as simply saying language = None shouldn't be there, but it doesn't rule out specifying language correctly

After all "explicit is better than implicit" (Zen of Python ;)

@harrism harrism added this to PR-WIP in v22.08 Release via automation Jun 21, 2022
@harrism harrism added the 3 - Ready for review Ready for review by team label Jun 21, 2022
@bdice
Copy link
Contributor

bdice commented Jun 21, 2022

@jakirkham You’re right. I thought “en” and undefined might have different semantics (with undefined being closer to the previous value of None) but that’s not the case. See sphinx-doc/sphinx#10067. Yes, explicit is better here.

python/docs/conf.py Outdated Show resolved Hide resolved
@jakirkham
Copy link
Member Author

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 8b86993 into rapidsai:branch-22.08 Jun 22, 2022
v22.08 Release automation moved this from PR-WIP to Done Jun 22, 2022
@jakirkham jakirkham deleted the doc_cfg_lang_en branch June 22, 2022 04:41
@jakirkham jakirkham removed the 3 - Ready for review Ready for review by team label Jun 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working non-breaking Non-breaking change Python Related to RMM Python API
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants