agoessling / rules_sphinx

Bazel rules for building Sphinx documentation.
MIT License
10 stars 3 forks source link

Unable to run examples #3

Closed gopher-maker closed 1 year ago

gopher-maker commented 1 year ago

Firstly, the instructions in the README.md need updating with the correct package paths (i.e. add root_dir to paths):

bazel build @rules_sphinx//test/root_dir:test_docs bazel run @rules_sphinx//test/root_dir:test_docs.view

Secondly, both commands fail with a config directory doesn't contain a conf.py file error. Full stack trace with redacted personal path details:

$ bazel build --verbose_failures  @rules_sphinx//test/root_dir:test_docs

INFO: Analyzed target @rules_sphinx//test/root_dir:test_docs (0 packages loaded, 0 targets configured).
INFO: Found 1 target...
ERROR: /private/var/tmp/_bazel_<username>/844c904a51a667656eadf1e758fa5b6e/external/rules_sphinx/test/root_dir/BUILD:10:12: Building Sphinx HTML documentation for test_docs. failed: (Exit 2): sphinx_build_wrapper failed: error executing command 
  (cd /private/var/tmp/_bazel_<username>/844c904a51a667656eadf1e758fa5b6e/sandbox/darwin-sandbox/534/execroot/syshil_sw && \
  exec env - \
  bazel-out/darwin-opt-exec-2B5CBBC6/bin/external/rules_sphinx/sphinx/tools/sphinx_build_wrapper -b html -q bazel-out/darwin-fastbuild/bin/external/rules_sphinx/test/root_dir/test_docs_sandbox/../rules_sphinx/test/root_dir bazel-out/darwin-fastbuild/bin/external/rules_sphinx/test/root_dir/test_docs_html)
# Configuration: 63684d86ff47f33398646ba0e3860d9ff1fcad99873cee4f2aec407f500adbdd
# Execution platform: @local_config_platform//:host

Use --sandbox_debug to see verbose messages from the sandbox

Application error:
config directory doesn't contain a conf.py file (bazel-out/darwin-fastbuild/bin/external/rules_sphinx/test/root_dir/test_docs_sandbox/../rules_sphinx/test/root_dir)
Target @rules_sphinx//test/root_dir:test_docs failed to build
INFO: Elapsed time: 10.857s, Critical Path: 10.42s
INFO: 2 processes: 2 internal.
FAILED: Build did NOT complete successfully

Ditto for the bazel run command.

This is run in a Bash shell on Mac running OSX 11.5.2.

Bazel environment:

$ bazel version

Build label: 5.0.0
Build target: bazel-out/darwin-opt/bin/src/main/java/com/google/devtools/build/lib/bazel/BazelServer_deploy.jar
Build time: Wed Jan 19 14:15:55 2022 (1642601755)
Build timestamp: 1642601755
Build timestamp as int: 1642601755

Same error with equivalent Bazel environment on Ubuntu 20.04.

agoessling commented 1 year ago

With the v0.2.0 release I'm not able to reproduce this. Could you try it and let me know if it is still failing on Ubuntu?