Skip to content

Only render cross-provider dependencies if they're optional#63906

Open
TylerLubeck wants to merge 2 commits intoapache:mainfrom
TylerLubeck:breeze-docs-extras
Open

Only render cross-provider dependencies if they're optional#63906
TylerLubeck wants to merge 2 commits intoapache:mainfrom
TylerLubeck:breeze-docs-extras

Conversation

@TylerLubeck
Copy link

This mirrors what happens when generating pyproject.toml - if providers are listed in the package requirements, they are not added as extras.

The difference here - and where I'm hoping for some feedback - is that the docs say both "This is a cross provider dependency" and "here's the extra you can use to install it if you want".

Basically, do we want to differentiate between optional and required cross provider dependencies, but still show both? Or perhaps rename the docs section "optional cross provider dependencies"? This PR currently chooses to do neither, and just doesn't show the cross provider dependency if it's also a required dependency.

closes: #63891


Was generative AI tooling used to co-author this PR?

Nope

@potiuk
Copy link
Member

potiuk commented Mar 19, 2026

Basically, do we want to differentiate between optional and required cross provider dependencies, but still show both? Or perhaps rename the docs section "optional cross provider dependencies"? This PR currently chooses to do neither, and just doesn't show the cross provider dependency if it's also a required dependency.

Good catch. Yes I think renaming the docs session to optional is a good idea - feel free to amend the commit, you will need to change template and regenerate the docs (look for --apply-templates-only I think)

@TylerLubeck
Copy link
Author

TylerLubeck commented Mar 19, 2026

boy howdy regenerating the docs makes this a big PR.

I split the commits to hopefully make review easier, key stuff is in the first one.

and thank you for the --apply-templates-only pointer, that would've taken me a bit to find. Full regen command ended up being

breeze release-management prepare-provider-documentation --reapply-templates-only --only-min-version-update

Leaving off the last argument resulted in

Release date is required unless --only-min-version-update is used!

and picking a release date felt presumptuous at best

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:dev-tools backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Breeze mis-generates "cross provider dependency" docs

2 participants