readthedocs
[Request action] Action to trigger ReadTheDocs application service
Suggestion
Instead of the RTD application always triggering its jobs, first check if in the commit there exists a github workflow that triggers readthedocs/actions/build (or whatever the name will end up being), and if it exists, do NOT trigger the default rtd workflow. Instead, have the action create an appropriate request to trigger it.
This is similar to dfm/rtds-action, but in that case it does not trigger the rtd workflow, it simply uploads the generated documentation. This action is intended to be much simpler, just to trigger the already present rtd workflow.
Benefit
- fine-grained control of when a RTD action is performed, e.g. only if
docsfolder is altered
This would be a nice feature.
We are integrating R documents and JVM documents into the Sphinx site. These documents are built separately due to resource requirements and the rtd builder needs to wait and download the artifacts. Having a GitHub action to trigger RTD build can solve the problem.
Closing as this feature was already integrated into the application via the GitHub App. Read more about this in https://about.readthedocs.com/blog/2025/06/announcing-our-github-app-beta/
