Skip to content

feat: add sphinx-jsonschema extension for JSON Schema rendering#553

Open
a-zw wants to merge 1 commit into
eclipse-score:mainfrom
etas-contrib:json-schema-extension
Open

feat: add sphinx-jsonschema extension for JSON Schema rendering#553
a-zw wants to merge 1 commit into
eclipse-score:mainfrom
etas-contrib:json-schema-extension

Conversation

@a-zw
Copy link
Copy Markdown
Contributor

@a-zw a-zw commented May 22, 2026

@github-actions
Copy link
Copy Markdown

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //src:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: 1edf60c4-9a01-48d2-9d95-e8d81038a8cc
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
WARNING: Target pattern parsing failed.
ERROR: Skipping '//src:license-check': no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
ERROR: no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
INFO: Elapsed time: 4.530s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@github-actions
Copy link
Copy Markdown

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

@a-zw
Copy link
Copy Markdown
Contributor Author

a-zw commented May 22, 2026

Checks report:

  • Fixed missing header in: docs/reference/metamodel.rst
  • ERROR: /home/runner/work/docs-as-code/docs-as-code/BUILD:19:5: Sphinx building needs for //:needs_json failed: (Exit 1): sphinx_build failed: error executing SphinxBuildDocs command (from target //:needs_json) bazel-out/k8-opt-exec-ST-d57f47055a04/bin/sphinx_build @bazel-out/k8-fastbuild/bin/needs_json/_build/needs-0.params

Locally tests and linting passes cleanly. 🤷

Comment thread src/requirements.txt
--hash=sha256:f82bf179951d58f55dca78ab3706aeafa496b741a91b1911d371441127d64282
# via -r requirements.in
# via -r src/requirements.in
sphinx-jsonschema==1.19.2 \
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This repo is archived & has a GPL3-License. We can not add that no?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Why not?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think useblocks is only developing their ubcode schema forward https://sphinx-needs.readthedocs.io/en/stable/schema/index.html#schema-violation-report-json-file

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why not?

I think cause it is not compatible with Apache 2.0 as well as eclipse says it can not be used in eclipse projects.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

yeah there was a list anywhere but i lost the link

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Imho we are not "using" the extension in the sense of the license: We do not redistribute it. We do not redistribute compilations of it. We only provide build instructions.

I guess we need to involve the Eclipse Foundation Intellectual Property Team then?

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

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

Add Sphinx json-schema extension

3 participants