Skip to content

Sphinx Fixes for Docs #221

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
wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −1
Open

Sphinx Fixes for Docs #221

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
8 changes: 7 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,13 @@

# Mock torch & fastai imports as per suggestion in
# https://github.com/sphinx-doc/sphinx/issues/6521#issuecomment-505765893
autodoc_mock_imports = ["torch", "fastai"]
autodoc_mock_imports = [
"torch",
"fastai",
"psycopg", # Required by databricks_ai_bridge.lakebase
"psycopg_pool", # Required by databricks_ai_bridge.lakebase
"langgraph.checkpoint.postgres", # Required by databricks_langchain.checkpoint
]
Copy link
Contributor

@jennsun jennsun Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we still have to do this if these dependencies/packages are lazily imported? We updated to do so as part of the this fix, so not sure if it automatically has to be imported here?
#224

Copy link
Member

@fanzeyi fanzeyi Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am guessing that we still need to. We are still going to build docs for classes that uses lakebase and `psycopg.


# The name of an image file (relative to this directory) to place at the top of
# the title page.
Expand Down
5 changes: 5 additions & 0 deletions docs/source/latest/databricks_ai_bridge.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,8 @@ Databricks AI Bridge Python API
:members:
:undoc-members:
:show-inheritance:

.. automodule:: databricks_ai_bridge.lakebase
:members:
:undoc-members:
:show-inheritance: