chore(docs): add SparkClient to SDK API reference#355
chore(docs): add SparkClient to SDK API reference#355khanavi272-spec wants to merge 2 commits intokubeflow:mainfrom
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
🎉 Welcome to the Kubeflow SDK! 🎉 Thanks for opening your first PR! We're happy to have you as part of our community 🚀 Here's what happens next:
Join the community:
Feel free to ask questions in the comments if you need any help or clarification! |
| .. autoclass:: kubeflow.spark.SparkClient | ||
| :members: | ||
| :show-inheritance: |
There was a problem hiding this comment.
Adding .. autoclass:: kubeflow.spark.SparkClient will cause the docs CI job (uv sync --group docs) to import kubeflow.spark.api.spark_client, which imports pyspark at module import time; since pyspark isn’t installed in the docs dependency group, Sphinx will fail to build the docs. Fix by either mocking pyspark for autodoc (e.g., via autodoc_mock_imports in docs/source/conf.py) or ensuring the docs build installs the spark extra / pyspark dependency.
| .. autoclass:: kubeflow.spark.SparkClient | |
| :members: | |
| :show-inheritance: | |
| .. note:: | |
| The ``SparkClient`` API reference is not built in this documentation | |
| configuration because it depends on the optional ``pyspark``/``spark`` | |
| extra, which is not installed for the docs build. |
astefanutti
left a comment
There was a problem hiding this comment.
Thanks @khanavi272-spec!
/retitle chore(docs): add SparkClient to SDK API reference
/ok-to-test
fixes #354
|
@khanavi272-spec can you sign the commit please. /assign @andreyvelich @kramaranya @Shekharrajak @tariq-hasan |
|
@astefanutti: GitHub didn't allow me to assign the following users: tariq-hasan. Note that only kubeflow members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
What this PR does / why we need it:
Which issue(s) this PR fixes (optional, in
Fixes #<issue number>, #<issue number>, ...format, will close the issue(s) when PR gets merged):Fixes #
Checklist: