Skip to content

feat: make docs data root bundle data - #785

Merged
AlexanderLanin merged 3 commits into
mainfrom
cleanup/root-bundle-data
Sep 1, 2026
Merged

feat: make docs data root bundle data#785
AlexanderLanin merged 3 commits into
mainfrom
cleanup/root-bundle-data

Conversation

@AlexanderLanin

@AlexanderLanin AlexanderLanin commented Sep 1, 2026

Copy link
Copy Markdown
Member

What changed

  • Make docs(data = [...]) declare files on the public root :docs_bundle.
  • Retain sphinx_docs_library only as the internal adapter that maps those root-bundle files into Sphinx's sandboxed source tree.
  • Describe a bundle without source_dir as the same bundle model with generated/supporting content, rather than a separate data-only concept.
  • Remove raw source files from sphinx_docs.tools; the root bundle already provides them as build inputs.

Why

docs(data) and docs_bundle(data) previously described different ownership models. The root documentation is itself a bundle, so the public API should have one data ownership model.

Breaking?

Technically this is an API change. Technically it's breaking. We can rather safely assume that no-one is using the API, therefore we can pass that as a pure patch release.

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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: 05f7f99d-28de-43c0-9caf-ed1230f9d6b7
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
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: 6.472s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Documentation preview for this pull request is available at:
pr-785: https://eclipse-score.github.io/docs-as-code/pr-785/

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Refactors root documentation data to use the same bundle ownership model as mounted documentation.

Changes:

  • Adds docs(data) files to the public root bundle.
  • Retains an internal Sphinx staging adapter.
  • Updates documentation and adds a literalinclude regression fixture.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs.bzl Refactors root data ownership and Sphinx wiring.
docs/reference/bazel_macros.rst Documents unified bundle semantics.
docs/how-to/generated_docs.rst Updates generated-document guidance.
docs/how-to/bundles/examples.rst Removes separate “data-only” terminology.
src/tests/docs_bzl/test_basic_docs.py Describes the sandbox regression coverage.
src/tests/docs_bzl/scenarios/basic_docs/BUILD Declares supporting root data.
src/tests/docs_bzl/scenarios/basic_docs/docs/index.rst Includes the supporting fixture.
src/tests/docs_bzl/scenarios/basic_docs/supporting-example.txt Adds fixture content.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Basic Test
==========

.. literalinclude:: ../supporting-example.txt

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

yeah thanks... thats bug #778

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.

So this needs fixing?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

yeah, but unrelated to this PR. This PR will simplify the fix as we have fewer concepts to take care of.

@AlexanderLanin AlexanderLanin changed the title refactor: make docs data root bundle data feat: make docs data root bundle data Sep 1, 2026
@MaximilianSoerenPollak

Copy link
Copy Markdown
Contributor

So this is almost just a rename except that one deletion in the tools section?

@AlexanderLanin

Copy link
Copy Markdown
Member Author

So this is almost just a rename except that one deletion in the tools section?

Yeah it's 80% concept, and ~2 lines changed.

@AlexanderLanin
AlexanderLanin merged commit 94bda7c into main Sep 1, 2026
39 of 40 checks passed
@AlexanderLanin
AlexanderLanin deleted the cleanup/root-bundle-data branch September 1, 2026 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

3 participants