Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
#778 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
55/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Área
build-system, documentation

Línea de trabajo

Empieza por docs/how-to/bundles/examples.rst y la definición pública de //:docs_bundle; después reproduce el fallo con la configuración external-bundle y bazel run //:docs. Rastrea qué archivos de ejemplo se exportan fuera de docs/. Se considera terminado cuando tanto las compilaciones standalone como las external-bundle se completan correctamente sin errores de confinamiento de rutas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
11
Forks
33
Merge medio
22 h 43 min
PR fusionados (30 d)
65

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de eclipse-score/docs-as-code

Todos los issues de eclipse-score/docs-as-code

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.