[utah-devel] readthedocs.org bzr plugin
Javier Collado
javier.collado at canonical.com
Tue Aug 21 14:04:07 UTC 2012
Hello,
readthedocs.org takes care of building the documentation by itself when
it detects that the branch has updated (I'm not sure of what's the
checking frequency though).
However, just in case we're not happy with that, there's a way to
trigger a documentation build by sending an HTTP POST request to:
http://readthedocs.org/build/4313
This can be used to write a bzr plugin that sends such a request after
change have been pushed to lp:utah/dev. Since plugins cannot be enforced
in a particular branch for security reasons, I'm sending it attached for
your convenience.
To install the plugin, just copy the .py file to ~/.bazaar/plugins and
you're ready to update the documentation on every push. To check that
the installation has been successful, look for "readthedocs" in the "bzr
plugins" command output.
Note that I haven't tested the plugin because I didn't have anything to
push to the branch, but I it should work since I just updated an old
plugin I had that worked fine and updated the documentation strings and
the urls for utah. Let me know if you find any problem.
Best regards,
Javier
-------------- next part --------------
A non-text attachment was scrubbed...
Name: readthedocs.py
Type: text/x-python
Size: 1047 bytes
Desc: not available
URL: <https://lists.ubuntu.com/archives/ubuntu-utah-devel/attachments/20120821/48f5b608/attachment.py>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 262 bytes
Desc: OpenPGP digital signature
URL: <https://lists.ubuntu.com/archives/ubuntu-utah-devel/attachments/20120821/48f5b608/attachment.pgp>
More information about the Ubuntu-utah-devel
mailing list