Skip to content

Commit dbbe2f1

Browse files
chore: fix docs builds [backport 3.19] (#15540)
Backport fdd8fed from #15533 to 3.19. ## Description Our docs are failing to build in readthedocs but the build_docs job is passing in gitlab ([passing](https://gitlab.ddbuild.io/DataDog/apm-reliability/dd-trace-py/-/jobs/1269199858/viewer), [failing](https://app.readthedocs.org/projects/ddtrace/builds/30557822/)). Fixed ReadTheDocs build failures by skipping spelling checks in ReadTheDocs. Different spelling backends between GitLab CI and ReadTheDocs cause inconsistent results (e.g., "jitter", "durations" pass in CI but fail in RTD). Changes: - Skip spelling check in ReadTheDocs (validated in CI) ## Testing - Verified spelling check passes locally - GitLab CI continues to run all validation checks ## Risks None Co-authored-by: Munir Abdinur <[email protected]>
1 parent cf60ea7 commit dbbe2f1

File tree

2 files changed

+5
-8
lines changed

2 files changed

+5
-8
lines changed

docs/spelling_wordlist.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,3 +346,5 @@ xfail
346346
yaaredis
347347
openai-agents
348348
validators
349+
jitter
350+
durations

scripts/docs/build.sh

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,13 @@
22
set -eux
33

44
if [[ "${READTHEDOCS:-}" = "True" ]]; then
5-
# We skip here because we do not check spelling in RTD
6-
echo "Skipping install"
5+
echo "Skipping spelling check in RTD"
76
else
87
if [[ "$(uname)" == "Darwin" ]]; then
98
brew install enchant
9+
export PYENCHANT_LIBRARY_PATH=$(brew --prefix enchant)/lib/libenchant-2.dylib
1010
fi
11+
sphinx-build -vvv -W -b spelling docs docs/_build/spelling
1112
fi
12-
13-
if [[ "$(uname)" == "Darwin" ]]; then
14-
export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib
15-
fi
16-
1713
reno lint
18-
sphinx-build -vvv -W -b spelling docs docs/_build/html
1914
sphinx-build -vvv -W -b html docs docs/_build/html

0 commit comments

Comments
 (0)