[openstack-dev] [docs][badges][all] Docs gate broken for projects that include README.rst in docs

Flavio Percoco flavio at redhat.com
Fri Dec 9 16:20:34 UTC 2016


Some docs jobs seem to be broken by the latest (or not?) docutils release. The
breakage seems to be related to the latest addition of the bages patch. The docs
generation doesn't like to have remote images. It used to be a warning but it
seems to have turned into an error now. While this is reported and fixed
upstream, we can workaround the issue by tagging the image as remote.

An example of this fix can be found here: https://review.openstack.org/#/q/topic:readme-badge-fix

Note that this is mostly relevant for projects that include the readme files in
their documentation. If your project doesn't do it, you can ignore this email.
That said, I'd recommend all projects to do it.


Flavio Percoco
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 862 bytes
Desc: not available
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20161209/33a8f1cb/attachment.pgp>

More information about the OpenStack-dev mailing list