feat: make docs data root bundle data - #785
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run --lockfile_mode=error //src:license-checkStatus: Click to expand output |
|
Documentation preview for this pull request is available at: |
There was a problem hiding this comment.
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
literalincluderegression 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 |
There was a problem hiding this comment.
So this needs fixing?
There was a problem hiding this comment.
yeah, but unrelated to this PR. This PR will simplify the fix as we have fewer concepts to take care of.
|
So this is almost just a rename except that one deletion in the tools section? |
Yeah it's 80% concept, and ~2 lines changed. |
04bb67b to
8d3501a
Compare
What changed
docs(data = [...])declare files on the public root:docs_bundle.sphinx_docs_libraryonly as the internal adapter that maps those root-bundle files into Sphinx's sandboxed source tree.source_diras the same bundle model with generated/supporting content, rather than a separate data-only concept.sphinx_docs.tools; the root bundle already provides them as build inputs.Why
docs(data)anddocs_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.