Skip to content

include external needs into needs.json #193

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

AlexanderLanin
Copy link
Member

No description provided.

@Copilot Copilot AI review requested due to automatic review settings July 31, 2025 17:27
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enables the inclusion of external needs into the needs.json file by uncommenting and setting the needs_builder_filter configuration option in the Sphinx documentation configuration.

  • Uncomments and activates the needs_builder_filter configuration option
  • Sets the filter to an empty string to include all external needs

@@ -64,4 +64,6 @@

# Enable numref
numfig = True
# needs_builder_filter = ""

# Include all external needs into needs.json
Copy link
Preview

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

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

The comment on line 68 states this will 'Include all external needs into needs.json', but setting needs_builder_filter to an empty string may not achieve this purpose. Consider adding documentation or a more descriptive comment explaining what an empty filter accomplishes versus other filter values.

Suggested change
# Include all external needs into needs.json
# Include all external needs into needs.json by setting needs_builder_filter to an empty string.
# An empty string ensures that no filtering is applied, and all external needs are included.

Copilot uses AI. Check for mistakes.

Copy link

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //src:license-check

Status: ✅ Passed

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.3.0) and connecting to it...
INFO: Invocation ID: 17e9ff2c-3535-49e5-9b42-838d69f7c18e
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //src:license-check (69 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (94 packages loaded, 239 targets configured)

Analyzing: target //src:license-check (121 packages loaded, 2363 targets configured)

Analyzing: target //src:license-check (126 packages loaded, 2412 targets configured)

INFO: Analyzed target //src:license-check (129 packages loaded, 4428 targets configured).
[9 / 13] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache
INFO: Found 1 target...
Target //src:license.check.license_check up-to-date:
  bazel-bin/src/license.check.license_check
  bazel-bin/src/license.check.license_check.jar
INFO: Elapsed time: 13.489s, Critical Path: 0.35s
INFO: 13 processes: 4 disk cache hit, 9 internal.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/src/license.check.license_check src/formatted.txt <args omitted>
[main] INFO Querying Eclipse Foundation for license data for 84 items.
[main] INFO Found 58 items.
[main] INFO Querying ClearlyDefined for license data for 26 items.
[main] INFO Found 26 items.
[main] INFO Vetted license information was found for all content. No further investigation is required.

Copy link

The created documentation from the pull request is available at: docu-html

@MaximilianSoerenPollak
Copy link
Contributor

I wonder if we should put this into docs as code inside the extensions. Maybe metamodel.
Then each project doesn't have to add this to conf. Py?

@MaximilianSoerenPollak
Copy link
Contributor

/consumer-test

@AlexanderLanin
Copy link
Member Author

not sure we still want that

@AlexanderLanin AlexanderLanin marked this pull request as draft August 1, 2025 09:02
@@ -64,4 +64,6 @@

# Enable numref
numfig = True
Copy link
Contributor

Choose a reason for hiding this comment

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

Another test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Draft
Development

Successfully merging this pull request may close these issues.

2 participants