fix: repair broken Sphinx docs deployment to GitHub Pages#516
Merged
asimrout-eng merged 1 commit intomainfrom May 4, 2026
Merged
fix: repair broken Sphinx docs deployment to GitHub Pages#516asimrout-eng merged 1 commit intomainfrom
asimrout-eng merged 1 commit intomainfrom
Conversation
The SDK documentation at python.docs.firebolt.io/sdk_documentation/latest/ has been returning 404 due to three issues: - destination_dir had a typo: "sdk_documenation" instead of "sdk_documentation" - keep_files was not set, so Allure report deployments wiped the docs - summary URL referenced the old domain (old.docs.firebolt.io) Co-authored-by: Cursor <cursoragent@cursor.com>
|
kop
approved these changes
May 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
destination_dir:sdk_documenation→sdk_documentation, so the deployed path matches the URL linked from docs.firebolt.io.keep_files: trueto thepeaceiris/actions-gh-pagesstep. Without this, each docs deployment wiped the entiregh-pagesbranch (including Allure reports), and conversely Allure deployments wiped the docs — which is why thesdk_documenation/directory no longer exists ongh-pagestoday.old.docs.firebolt.iodomain topython.docs.firebolt.io(the CNAME configured ongh-pages).Follow-up needed
After merging, trigger the workflow manually (
workflow_dispatch) or wait for the next release so the docs get deployed. The link on docs.firebolt.io/guides/developing-with-firebolt/connecting-with-python also needs updating fromsdk_documenationtosdk_documentation— that lives in the separate docs repo.Test plan
Build documentationworkflow manually from Actions tabhttps://python.docs.firebolt.io/sdk_documentation/latest/returns 200https://python.docs.firebolt.io/allure/are still intactMade with Cursor