[Python] Configure Sphinx docs #2496
Merged
Conversation
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
kanterov
requested review from
andrewnester,
denik,
pietern and
shreyas-goenka
as code owners
kanterov
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
kanterov
commented
Mar 14, 2025
|
|
||
| `databricks-bundles` package implements Python support for Databricks Asset Bundles. | ||
|
|
||
| See `What is Python support for Databricks Asset Bundles? (TBD) <#>`_. |
Collaborator
Author
There was a problem hiding this comment.
It should link the user guide a bit later.
kanterov
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
kanterov
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
pietern
approved these changes
Mar 17, 2025
| "databricks.bundles.core._variable._T": "databricks.bundles.core.T", | ||
| "databricks.bundles.core._diagnostics._T": "databricks.bundles.core.T", | ||
| "databricks.bundles.core._resource_mutator._T": "databricks.bundles.core.T", | ||
| # use dataclasses instead of typed dicts used in databricks.bundles.core |
Contributor
There was a problem hiding this comment.
Is this comment still accurate?
Collaborator
Author
There was a problem hiding this comment.
Yes. Sphinx has a problem with type aliases. It looks into the signature it references "JobParam". The actual value is JobDict | Job, but there is nothing in the docs that resembles JobDict. So we just override it to link to Job.
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.
Changes
Configure Sphinx docs for Python code.
There is a lot of customization for Sphinx output to make complex type signatures readable:
After that, when the rest of the code is ready, we can automatically publish docs into gh-pages.
Tests
Adds CI check