Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Public docs_bundle is not self-contained because bundle examples include files outside docs/

オープン
#778 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
55/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
活発

調査の方向性

docs/how-to/bundles/examples.rst と公開されている //:docs_bundle 定義から始め、external-bundle 構成と bazel run //:docs を使って失敗を再現します。どの example ファイルが docs/ の外部にエクスポートされるかを追跡します。standalone ビルドと external-bundle ビルドの両方が path-confinement エラーなしで成功すれば完了です。

索引モデルが issue の本文から書いたものです。

説明

bug

Problem

The public //:docs_bundle includes docs/how-to/bundles/examples.rst and the nested bundle example mounts. That page uses literalinclude paths such as:

../../../src/tests/docs_bzl/scenarios/nested_bundles/BUILD
../../../src/tests/docs_bzl/scenarios/data_files_runfiles/BUILD
../../../src/tests/docs_bzl/scenarios/external_bundle/BUILD

These files are outside the docs/ source directory. The documentation builds successfully as the standalone docs-as-code project, but fails when its docs_bundle is consumed by another Sphinx project because sphinx-mounts enforces path confinement for mounted documents.

Reproduction

Consume @score_docs_as_code//:docs_bundle from eclipse-score/reference_integration with score_docs_as_code 8.1.0:

{
    "bundle": "@score_docs_as_code//:docs_bundle",
    "mount_at": "process_methods_tools/docs_as_code",
    "attach_to": "process_methods_tools",
}

Run:

bazel run //:docs

Observed result:

sphinx-mounts: mounted doc process_methods_tools/docs_as_code/how-to/bundles/examples references a file outside its bundle root: .../score_docs_as_code+/src/tests/docs_bzl/scenarios/nested_bundles/BUILD is not under .../score_docs_as_code+/docs

A previous closed PR, #514, attempted to add support for literalinclude outside docs/; this is the same class of problem now exposed through the public external bundle and should be resolved either by packaging the included files into the bundle or by excluding these test-fixture examples from the exported bundle.

Expected behavior

The public docs_bundle should be self-contained and mountable by another Sphinx project without path-confinement errors. The standalone documentation build and the external-bundle build should exercise the same contract.

主要言語
Python
スター
11
フォーク
33
平均マージ
22時間 43分
マージ済み PR(30日)
65

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

eclipse-score/docs-as-code のほかの issue

eclipse-score/docs-as-code の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。