Repository navigation
fix(docs): restore Python SDK reference pages and fix rendering (FB-5346) - #561
Open
simonzelenskifbio wants to merge 18 commits into
Open
simonzelenskifbio wants to merge 18 commits into
simonzelenskifbio wants to merge 18 commits into
Conversation
simonzelenskifbio
force-pushed
the
fix/fb-5346-python-sdk-docs
branch
from
October 29, 2026 14:59
f2acef6 to
535d6e7
Compare
|
This branch has not been deployed
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
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.
Issue
FB-5346
Description
The SDK documentation build reported 28 warnings and diagnostics while still succeeding, leaving missing API reference content and omitted connection-parameter tables.
Correct stale module references, document the V2 engine instead of its empty compatibility class, and remove the nonexistent async utility section. Repair both parameter tables and enable text wrapping. Fix the streaming example formatting, heading underline, duplicate labels/API entries, and ambiguous Connection links.
Changes are limited to documentation and Sphinx configuration. SDK behavior and publishing workflows are unchanged.
Validation
-E -W --keep-going: zero warnings.git diff --checkpasses.Note
Low Risk
Documentation and Sphinx configuration only; no SDK runtime or publishing behavior changes.
Overview
Restores a clean Sphinx build by pointing autodoc at the real
firebolt.model.V2andfirebolt.service.V2modules instead of empty or stale paths, drops the nonexistentasync_db.utilsection, and avoids duplicateconnect/ ambiguousConnectionentries via exclusions and adoctree-readhook inconf.py.Fixes reader-facing RST issues: connection-parameter tables get a
connection-parametersclass pluscustom.cssso long text wraps; Core/cloud parameter table alignment, a broken section underline, streaming-example spacing, and theEngine.updatexref inManaging_resources.rstare corrected. The client docs section is retitled HTTP clients.Reviewed by Cursor Bugbot for commit 2ac346d. Bugbot is set up for automated code reviews on this repo. Configure here.