Build documentation PR previews only if files under a path have changed
See original GitHub issueIt would be helpful if we could optionally configure a path to our documentation, and have ReadTheDocs only build previews of the docs if files underneath that path were changed. I’d imagine a configuration box in the Admin
panel that was something like
Build PR previews only for changes under folder: docs/
For documentation builds that take a while to build, this would reduce the time for PRs that only change code, but no docs, which is probably quite a lot of PRs! I think that it would also reduce the load on ReadTheDocs build servers, since a documentation change is probably more rare than a code change.
(note: I couldn’t find a “feature request” issue template, which makes me wonder if this is not a good place to open suggestions like this, I am happy to direct this issue elsewhere if that’s better)
Issue Analytics
- State:
- Created 2 years ago
- Reactions:3
- Comments:8 (7 by maintainers)
I think we could set reasonable expectations like
docs/
directory doesn’t mean that the documentation can’t change by other means. This is true for source code docstrings but also dependencies, external data, and possibly other factors.Does this sound like a useful thing?
With the proposed implementation, we are delivering this responsibility to the user itself. The user is responsible to guarantee the check is correct for their own scenario. As it’s using just an exit code from a custom command, it’s pretty flexible to cover most of the use cases and people can write just a simple command or a complex Python script.