Skip to content

chore: fix docs builds [backport 3.19] #15540

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

Open
dd-octo-sts wants to merge 1 commit into
base: 3.19
Choose a base branch
from
+5 −8
Open

chore: fix docs builds [backport 3.19] #15540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions docs/spelling_wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,3 +346,5 @@ xfail
yaaredis
openai-agents
validators
jitter
durations
11 changes: 3 additions & 8 deletions scripts/docs/build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,13 @@
set -eux

if [[ "${READTHEDOCS:-}" = "True" ]]; then
# We skip here because we do not check spelling in RTD
echo "Skipping install"
echo "Skipping spelling check in RTD"
else
if [[ "$(uname)" == "Darwin" ]]; then
brew install enchant
export PYENCHANT_LIBRARY_PATH=$(brew --prefix enchant)/lib/libenchant-2.dylib
fi
sphinx-build -vvv -W -b spelling docs docs/_build/spelling
fi

if [[ "$(uname)" == "Darwin" ]]; then
export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib
fi

reno lint
sphinx-build -vvv -W -b spelling docs docs/_build/html
sphinx-build -vvv -W -b html docs docs/_build/html
Loading