bazel-contrib / bazel-contrib/rules_python
sphinxdocs: implement content-based change detection plugin
- Dominant language
- Starlark
- Stars
- 688
- Forks
- 721
- Avg merge
- 14h 49m
- Merged PRs (30d)
- 81
Description
Sphinx has change detection to facilitate incremental rebuilding, but it's timestamp based. Bazel doesn't reliably preserve timestamps, nor are timestamps highly reliable, so this functionality isn't usable. This means sphinx has to rebuild everything, every time, which can get quite slow. Pigweed, for example, takes many minutes. Even in rules_python, it takes just under a minute (long enough where I think, "its just building docs, why is this taking so long?")
To fix this, I think we can implement a plugin that uses the `env-get-outdated` event; see this comment: https://github.com/sphinx-doc/sphinx/issues/11556#issuecomment-1667507177
api docs: https://www.sphinx-doc.org/en/master/extdev/event_callbacks.html#event-env-get-outdated
All it has to do is calculate a hash of the file and compare it to a previous hash.
Looking through those API docs, I wonder if some of those other events would be of interest, especially for a persistent worker.
Contributor guide
Assessment
This issue has not been assessed yet.