Webhooks

Web hooks are pretty amazing, and help to turn the web into a push instead of pull platform. We have support for hitting a URL whenever you commit to your project and we will try and rebuild your docs. This only rebuilds them if something has changed, so it is cheap on the server side. As anyone who has worked with push knows, pushing a doc update to your repo and watching it get updated within seconds is an awesome feeling.

Github

If your project is hosted on Github, you can easily add a hook that will rebuild your docs whenever you push updates:

  • Go to the “Settings” page for your project
  • Click “Webhooks & Services”
  • In the “Services” section, click “Add service”
  • In the list of available services, click “ReadTheDocs”
  • Check “Active”
  • Click “Add service”

Bitbucket

If your project is hosted on Bitbucket, you can easily add a hook that will rebuild your docs whenever you push updates:

  • Go to the “admin” page for your project
  • Click “Hooks”
  • In the available service hooks, select “Read the Docs”
  • Click “Add hook”

Others

Your ReadTheDocs project detail page has your post-commit hook on it; it will look something along the lines of http://readthedocs.org/build/<pk>. Regardless of which revision control system you use, you can just hit this URL to kick off a rebuild.

You could make this part of a hook using Git, Subversion, Mercurial, or Bazaar, perhaps through a simple script that accesses the build URL using wget or curl.