Skip to content

Commit c8249ba

Browse files
authored
[Python] Update Sphinx docs (#3791)
## Changes Update Sphinx docs with missing documentation for schemas and volumes. See also #3791 ## Why These docs are published on GitHub pages and are used by humans and AI agents ## Tests Using pre-commit check, generating docs, and inspecting the generated output manually
1 parent 85978da commit c8249ba

File tree

5 files changed

+28
-2
lines changed

5 files changed

+28
-2
lines changed

experimental/python/docs/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
project = "databricks-bundles"
1717
copyright = "2024, Databricks"
1818
author = "Gleb Kanterov"
19-
release = "beta"
2019

2120
# -- General configuration ---------------------------------------------------
2221
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

experimental/python/docs/databricks.bundles.core.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,7 @@ Methods
3838
Decorators
3939
-----------
4040
.. autodecorator:: databricks.bundles.core.job_mutator
41+
.. autodecorator:: databricks.bundles.core.pipeline_mutator
42+
.. autodecorator:: databricks.bundles.core.schema_mutator
43+
.. autodecorator:: databricks.bundles.core.volume_mutator
4144
.. autodecorator:: databricks.bundles.core.variables
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Schemas
2+
===============================
3+
4+
.. currentmodule:: databricks.bundles.schemas
5+
6+
**Package:** ``databricks.bundles.schemas``
7+
8+
Classes
9+
---------------
10+
11+
.. automodule:: databricks.bundles.schemas
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Volumes
2+
===============================
3+
4+
.. currentmodule:: databricks.bundles.volumes
5+
6+
**Package:** ``databricks.bundles.volumes``
7+
8+
Classes
9+
---------------
10+
11+
.. automodule:: databricks.bundles.volumes

experimental/python/docs/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
databricks-bundles (Beta)
1+
databricks-bundles
22
--------------------------------
33

44
`databricks-bundles` package implements Python support for Databricks Asset Bundles.
@@ -12,3 +12,5 @@ See `What is Python support for Databricks Asset Bundles? (TBD) <#>`_.
1212
databricks.bundles.core
1313
databricks.bundles.jobs
1414
databricks.bundles.pipelines
15+
databricks.bundles.schemas
16+
databricks.bundles.volumes

0 commit comments

Comments
 (0)