Implement a post-commit hook that pings Read The Docs

Created on 21 April 2015, about 10 years ago
Updated 16 May 2025, 3 days ago

Problem/Motivation

Updating documentation on readthedocs.org requires a manual action, unless Drupal.org implements a post-commit hook.
Some projects "fix" that by mirroring / moving their code to GitHub or Bitbucket, but that's a heavy workaround.

Drupal projects already using Read The Docs:

Proposed resolution

Implement a post-commit hook that pings http://readthedocs.org/build/<project_name>
Documentation about that can be found at https://docs.readthedocs.org/en/latest/webhooks.html

Remaining tasks

First of all, discuss if this is wanted.

User interface changes

Allow anyone who can edit a Drupal project page to specify the Read The Docs project name. Or distract it from Resources > Documentation 'Link to the project documentation' because it will mostly contain a Read The Docs name if the documentation got rendered over there.

So we could change the text input field description from 'Link to the project documentation' to 'Link to the project documentation. If it contains readthedocs.org, a new documentation build will be triggered with each commit pushed to the default branch.'

API changes

None.

✨ Feature request
Status

Closed: outdated

Version

3.0

Component

User interface

Created by

πŸ‡§πŸ‡ͺBelgium PieterDC Ghent

Live updates comments and jobs are added and updated live.
  • docs infrastructure

    Infrastructure/code improvements related to documentation. The Core Documentation team uses this tag.

  • git

    Used in Documentation issues for documentation related to Git

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024