fix(sphinxdocs): add retry logic when exit code 2 occurs (#3241)

Running Sphinx multiple times in the same process sometimes results in
an error ("exit code 2"). Digging in, this is likely a bug in the
sphinx_bzl plugin in how it merges data when parallel or incremental
builds are performed.

Until that's fixed, work around the problem by internally retrying the
Sphinx build when exit code 2 occurs. This is basically what we're doing
today and should reduce the number of flakes for the RTD builds.

Along the way, improve the error reporting to make it easier to diagnose
the underlying failure.
1 file changed
tree: e312e48855b37afd194016fdfe609cd9ab44a8bb
  1. .bazelci/
  2. .bcr/
  3. .ci/
  4. .github/
  5. docs/
  6. examples/
  7. gazelle/
  8. private/
  9. python/
  10. sphinxdocs/
  11. tests/
  12. tools/
  13. .bazelignore
  14. .bazelrc
  15. .bazelversion
  16. .editorconfig
  17. .git-blame-ignore-revs
  18. .gitattributes
  19. .gitignore
  20. .pre-commit-config.yaml
  21. .python-version
  22. .readthedocs.yml
  23. addlicense.sh
  24. AGENTS.md
  25. AUTHORS
  26. BUILD.bazel
  27. BZLMOD_SUPPORT.md
  28. CHANGELOG.md
  29. CONTRIBUTING.md
  30. CONTRIBUTORS
  31. internal_dev_deps.bzl
  32. internal_dev_setup.bzl
  33. LICENSE
  34. MODULE.bazel
  35. README.md
  36. RELEASING.md
  37. version.bzl
  38. WORKSPACE
  39. WORKSPACE.bzlmod
README.md

Python Rules for Bazel

Build status

Overview

This repository is the home of the core Python rules -- py_library, py_binary, py_test, py_proto_library, and related symbols that provide the basis for Python support in Bazel. It also contains package installation rules for integrating with PyPI and other indices.

Documentation for rules_python is at https://rules-python.readthedocs.io and in the Bazel Build Encyclopedia.

Examples live in the examples directory.

The core rules are stable. Their implementation is subject to Bazel's backward compatibility policy. This repository aims to follow semantic versioning.

The Bazel community maintains this repository. Neither Google nor the Bazel team provides support for the code. However, this repository is part of the test suite used to vet new Bazel releases. See How to contribute page for information on our development workflow.

Documentation

For detailed documentation, see https://rules-python.readthedocs.io

Bzlmod support

  • Status: Beta
  • Full Feature Parity: No

See Bzlmod support for more details.