Skip to content

Mark generated PyDABs doc pages as auto-generated - #7140

Merged
janniklasrose merged 1 commit into
mainfrom
janniklasrose/pydabs-docs-gitattributes
Oct 21, 2026
Merged

janniklasrose merged 1 commit into
mainfrom
janniklasrose/pydabs-docs-gitattributes

Conversation

@janniklasrose

Copy link
Copy Markdown
Member

Changes

Add python/docs/.gitattributes marking index.rst and the per-resource databricks.bundles.*.rst pages as linguist-generated. databricks.bundles.core.rst is hand-written and stays visible.

Why

pydabs-codegen has written these pages since #6727 (python/codegen/codegen/generated_docs.py), but the gitattributes from #6394 predate it and only cover the Python modules and test data. So new-resource PRs like #7094 show the doc pages as regular diffs.

python/databricks_tests/core/public_api.txt is left unmarked on purpose: it's the golden snapshot of the hand-written core API, and reviewers are meant to see changes to it.

Tests

git check-attr linguist-generated resolves to true for index.rst and databricks.bundles.jobs.rst, and to false for databricks.bundles.core.rst.

This pull request and its description were written by Isaac.

The .rst pages under python/docs/ have been generated by pydabs-codegen
since #6727, but #6394 predates that and only covered the Python modules
and test data. Mark index.rst and the per-resource pages as generated;
databricks.bundles.core.rst stays hand-written.

Co-authored-by: Isaac <no-reply@databricks.com>
@eng-dev-ecosystem-bot

Copy link
Copy Markdown
Collaborator

Integration test report

Commit: f55eb27

Run: 39558874737

Env ✅​pass 🙈​skip Time
✅​ aws linux-2core-8gb 281 15 4:12
✅​ aws-windows-latest-4core-16gb 283 13 5:22
✅​ azure linux-2core-8gb 280 15 4:23
✅​ azure-windows-latest-4core-16gb 282 13 3:39
✅​ gcp linux-2core-8gb 281 15 4:11
✅​ gcp-windows-latest-4core-16gb 283 13 3:35
Top 3 slowest tests (at least 2 minutes):
duration env testname
5:17 aws-windows-latest-4core-16gb TestAccept
3:32 azure-windows-latest-4core-16gb TestAccept
3:29 gcp-windows-latest-4core-16gb TestAccept

@janniklasrose
janniklasrose added this pull request to the merge queue Oct 21, 2026
Merged via the queue into main with commit be6a8e1 Oct 21, 2026
31 checks passed
@janniklasrose
janniklasrose deleted the janniklasrose/pydabs-docs-gitattributes branch October 21, 2026 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants