Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

♻️ Change NeedsBuilder format to needs #978

Merged
merged 2 commits into from
Aug 21, 2023
Merged

♻️ Change NeedsBuilder format to needs #978

merged 2 commits into from
Aug 21, 2023

Conversation

chrisjsewell
Copy link
Member

Changing the format from json to needs will make it more specific to target the NeedsBuilder, and any derivatives such as in #960, #961, #962

The format attribute of the sphinx builder is perhaps a bit misleading, since it is mainly used to target a "class" of builders, rather than a specific output format,
see: https://www.sphinx-doc.org/en/master/usage/builders/index.html

This will allow for logic in other parts of the sphinx-needs pipeline, e.g. to skip certain build steps not required by the needs builders.

@chrisjsewell chrisjsewell requested a review from danwos August 21, 2023 08:01
Copy link
Member

@danwos danwos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR 👍 Looks good.

@danwos danwos merged commit 78413f6 into master Aug 21, 2023
@danwos danwos deleted the builder-format branch August 21, 2023 09:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants