Skip to content

explicitly export LC_ALL for sphinx builds #2708

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.

Sign up for GitHub

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

Merged
merged 52 commits into from
May 13, 2025
Merged

explicitly export LC_ALL for sphinx builds #2708

Show file tree
Hide file tree
Changes from 49 commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
cca11cc
explicitly export LC_ALL for sphinx builds
valeriupredoi Apr 15, 2025
727978b
explicit conda env creation
valeriupredoi Apr 15, 2025
7ad84dc
set it to C
valeriupredoi Apr 15, 2025
c31ac4c
try a simple var export in RTD
valeriupredoi Apr 15, 2025
4039e13
set lc all in conf.py
valeriupredoi Apr 16, 2025
7c84a0b
remove var set in readthedocs config
valeriupredoi Apr 16, 2025
ae08a4a
reset circle env create
valeriupredoi Apr 16, 2025
4bafdf2
update inline
valeriupredoi Apr 16, 2025
d100fb7
unrun build docs at commit point on circle
valeriupredoi Apr 16, 2025
c3dd7dd
toss a print of the os environ
valeriupredoi Apr 16, 2025
d719931
export LANG to C as well
valeriupredoi Apr 16, 2025
696b0e1
try set CTYPE instead
valeriupredoi Apr 16, 2025
9fb66e7
print out RTDs locale see what they have
valeriupredoi Apr 16, 2025
d31e386
try LC_CTYPE to C
valeriupredoi Apr 16, 2025
ccdfb01
remove locale command
valeriupredoi Apr 16, 2025
1abf502
try with up set
valeriupredoi Apr 16, 2025
d780d0d
put quotes
valeriupredoi Apr 16, 2025
5b37cf3
remove all settings for RTD
valeriupredoi Apr 16, 2025
6803f5e
Add some debug info
bouweandela Apr 16, 2025
93af9fa
Add more debug info
bouweandela Apr 16, 2025
a2423f5
Try adding some quotes
bouweandela Apr 16, 2025
518d5c9
Another try
bouweandela Apr 16, 2025
bc68512
Another try
bouweandela Apr 16, 2025
42a9967
Update path to docs
bouweandela Apr 16, 2025
9449a76
Test a few more imports
bouweandela Apr 17, 2025
5ad06d8
Try many times
bouweandela Apr 17, 2025
1f8b5aa
Add some locale related tests
bouweandela Apr 17, 2025
2c2de9d
Try older python version
bouweandela Apr 17, 2025
18eb663
try a basic fix
valeriupredoi Apr 22, 2025
ca32530
Merge branch 'main' into force_setlocale_build_docs
valeriupredoi Apr 22, 2025
f8d95ae
agh Bouwe pin
valeriupredoi Apr 22, 2025
6dfabc1
Merge branch 'force_setlocale_build_docs' of https://github.com/ESMVa…
valeriupredoi Apr 22, 2025
9ebfdbe
comment out Bouwe
valeriupredoi Apr 22, 2025
9e8256d
revert all changes to RTD config file
valeriupredoi Apr 22, 2025
cdae502
Revert "revert all changes to RTD config file"
valeriupredoi Apr 22, 2025
9808e96
remove all the testing done by Bouwe
valeriupredoi Apr 22, 2025
6c93525
Merge branch 'main' into force_setlocale_build_docs
valeriupredoi May 7, 2025
29f2fe1
turn off language en in conf.py see if it breaks the show
valeriupredoi May 7, 2025
467ee84
remove unnecessary guff
valeriupredoi May 7, 2025
b7bf13a
fully restore conf.py to orig
valeriupredoi May 7, 2025
56ce47c
comment out Bouwe tests
valeriupredoi May 7, 2025
4588bb9
reput one of Bouwe tests
valeriupredoi May 7, 2025
eaadf06
reput all Bouwe's bits
valeriupredoi May 7, 2025
1231c3b
try again
valeriupredoi May 7, 2025
633744b
back to square a
valeriupredoi May 7, 2025
6322016
reset readthdeocs conf file to main
valeriupredoi May 7, 2025
3fda2d7
try set locale in conf.py
valeriupredoi May 7, 2025
09fcc94
add some docsting
valeriupredoi May 7, 2025
80d589f
Merge branch 'main' into force_setlocale_build_docs
valeriupredoi May 7, 2025
afc864e
Update doc/conf.py
valeriupredoi May 13, 2025
b3209c1
Merge branch 'main' into force_setlocale_build_docs
valeriupredoi May 13, 2025
494119f
Undo no longer needed change
bouweandela May 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,10 @@ jobs:
conda env export | tee /logs/environment.yml
pip freeze | tee /logs/requirements.txt
# Test building documentation
MPLBACKEND=Agg sphinx-build -W doc doc/build
# there is an ongoing issue with `locale` when building with Sphinx
# we are not sure if it is Sphinx or Iris at fault
# see https://github.com/ESMValGroup/ESMValCore/pull/2708
LC_ALL=C MPLBACKEND=Agg sphinx-build -W doc doc/build
- store_artifacts:
path: /logs

Expand Down
6 changes: 5 additions & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,11 @@

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
language = "en"
# a lot of issues with importing esmvalcore modules due to
# "incorrect" locale settings' this looks like a fix
import locale
locale.setlocale(locale.LC_ALL, 'C')

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down