"bazel build //:needs_json" does not work with index.rst in main folder

[RolandJentschETAS]

Description

According to the Process description (https://eclipse-score.github.io/process_description/main/_images/score_building_blocks_meta_model_deployment_example.drawio.svg) and the design decisions DR001 (https://eclipse-score.github.io/score/main/design_decisions/DR-001-proc.html) the module documentation and the component documentation is in different root folders.

/docs/...
/score/<component_name>/docs

See also the directory structure at https://eclipse-score.github.io/module_template/pr-58/

This is implemented as example in logging: See https://github.com/eclipse-score/logging/pull/82/changes.

But in the logging module the command "bazel build //:needs_json" does not work, because docs_as_code have trouble to collect the sphinx needs objects from the different paths. But for "bazel build //:docs" it works fine. So it is not a generic issue.

Analysis results

It seems it stops collecting the sphinx needs objects paths with BUILD parts inside.

Solution

No response

Error Occurrence Rate

Reproducible

How to reproduce

Execute in https://github.com/eclipse-score/logging/pull/82/changes the above command.

Supporting Information

No response

Classification

Minor

First Affected Release

not released (main)

Last Affected Release

not released (main)

Expected Fixed Release

before release (main)

Category

• Safety Relevant
• Security Relevant

[RolandJentschETAS]

Please notice that the code build with "bazel build //..." in many repositories also execute the following commands:

//:_needs_json/_sources
//:_needs_json_html
//:copyright-check
//:copyright-fix
//:copyright.check
//:copyright.check.find_main
//:copyright.check.venv
//:copyright.fix
//:copyright.fix.find_main
//:copyright.fix.venv
//:docs
//:docs.find_main
//:docs.venv
//:docs_check
//:docs_check.find_main
//:docs_check.venv
//:docs_combo
//:docs_combo.find_main
//:docs_combo.venv
//:docs_combo_experimental
//:docs_link_check
//:docs_link_check.find_main
//:docs_link_check.venv
//:docs_sources
//:format.check
//:format.check_Python_with_ruff
//:format.check_Rust_with_rustfmt
//:format.check_Starlark_with_buildifier
//:format.check_YAML_with_yamlfmt
//:format.fix
//:format.fix.check
//:format.fix_Python_with_ruff
//:format.fix_Python_with_ruff.check
//:format.fix_Rust_with_rustfmt
//:format.fix_Rust_with_rustfmt.check
//:format.fix_Starlark_with_buildifier
//:format.fix_Starlark_with_buildifier.check
//:format.fix_YAML_with_yamlfmt
//:format.fix_YAML_with_yamlfmt.check
//:ide_support
//:live_preview
//:live_preview.find_main
//:live_preview.venv
//:live_preview_combo_experimental
//:live_preview_combo_experimental.find_main
//:live_preview_combo_experimental.venv
//:merged_sourcelinks
//:needs_json
//:needs_json.run
//:needs_json.serve
//:sourcelinks_json
//:sphinx_build
//:starpls_server

[MaximilianSoerenPollak]

The issue is that bazel build creates a sandbox and that sandbox has NO IDEA that there is other documents outside of the docs folder specified and just does not copy them at all.

We have looked into a fix for this already but did not yet come up with something concrete.
If I have time I will investigate this today more.