-
Notifications
You must be signed in to change notification settings - Fork 19
Change docs_sources to spinx_docs_library #327
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
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run //src:license-checkStatus: Click to expand output |
|
The created documentation from the pull request is available at: docu-html |
c27915a to
ee9ebc2
Compare
This PR shows how a sphinx build can be moved to the execution phase of bazel builds. Addditionally, module documentation is now imported from `sphinx_docs_library` targets of dependent modules. This pr depends on changes in [PR](eclipse-score/docs-as-code#327)
This PR shows how a sphinx build can be moved to the execution phase of bazel builds. Addditionally, module documentation is now imported from `sphinx_docs_library` targets of dependent modules. This pr depends on changes in [PR](eclipse-score/docs-as-code#327)
docs.bzl
Outdated
| visibility = ["//visibility:public"], | ||
| ) | ||
|
|
||
| sphinx_docs_library( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't understand the need for this. Looking at its implementation, it is nearly the same as :docs_sources just with the prefix attribute attached as SphinxDocsLibraryInfo aspect.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The point is the prefix attribute, which make it possible to integrate the tree of rst files into an overall build as shown in the reference integration PR.
| name = "sphinx_docs_library", | ||
| srcs = [":docs_sources"], | ||
| prefix = "docs/modules/x/", | ||
| visibility = ["//visibility:public"], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How are sphinx build not running in execution phase now?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Die sphinx_docs_library as of today does not do anything. It just provides the anchor for the integration on a sphinx_docs target in another integration module. The actual sphinx build happens there. e.g. call bazel build //:html in PR.
| optional_options: | ||
| safety: "^(QM|ASIL_B)$" | ||
| security: "^(YES|NO)$" | ||
| optional_options: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This makes safety and security attributes optional again. Seems to be an accidental change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not an accidential change. I tried to pull in several (all) other modules in PR.
The build broke as many documents did not adopt this change yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the newest platform version these are fixed. With eclipse-score/reference_integration#43 it will be fixed here.
21756e3 to
9cba7b2
Compare
2d1c5a0 to
a18e7a9
Compare
a18e7a9 to
f6d4156
Compare
📌 Description
This PR introduces the 2 features:
🚨 Impact Analysis
✅ Checklist