网络挂钩

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

如果你的项目托管在Github, 你可以很容易添加一个文档挂钩,任何时候推送更新都会重建:

  • 到你的项目的 “settings” 页
  • 点击 “Service Hooks”
  • 在可用的服务挂钩里, 点击 “ReadTheDocs”
  • 检测 “Active”
  • 点击 “Update Settings”

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 “Services”
  • In the available service hooks, click “POST”
  • Put “http://readthedocs.org/bitbucket” as the URL
  • Click “Save Settings”

其它

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.

Read the Docs v: latest
Versions
latest
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.