Skip to content

fix(readthedocs): dummy site for non PR builds #317

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
ReenigneArcher merged 1 commit into from
Feb 19, 2026
Merged

fix(readthedocs): dummy site for non PR builds #317

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
26 changes: 26 additions & 0 deletions scripts/readthedocs_build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,32 @@ echo "github url: ${github_url}"
echo "github user: ${github_user}"
echo "github repo: ${github_repo}"

# For non PR builds, create a dummy index.html and exit early
# ReadTheDocs sets READTHEDOCS_VERSION_TYPE to "external" for PR/external builds
rtd_version_type="${READTHEDOCS_VERSION_TYPE:-}"
echo "ReadTheDocs version type: ${rtd_version_type}"
if [[ "${rtd_version_type}" != "external" ]]; then
echo "Not a pull request build, creating dummy index.html"
output_dir="${READTHEDOCS_OUTPUT}html"
mkdir -p "${output_dir}"
cat > "${output_dir}/index.html" <<'EOF'
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Preview not available</title>
</head>
<body>
<h1>Preview not available</h1>
<p>Previews are only generated for pull requests.</p>
</body>
</html>
EOF
echo "Dummy index.html written to ${output_dir}"
exit 0
fi

# set default directories
project_dir="."
theme_dir="."
Expand Down