[OpenStack-docs] Autogenerate the API Reference

Anne Gentle annegentle at justwriteclick.com
Fri May 8 13:06:23 UTC 2015


On Fri, May 8, 2015 at 7:55 AM, Jeremy Stanley <fungi at yuggoth.org> wrote:

> On 2015-05-08 07:48:57 -0500 (-0500), Anne Gentle wrote:
> > So I woke up this morning and realized, there's no way we should
> > be using stable/release branches to generate docs. The reviewers
> > are fewer for those branches and less likely to know anything
> > about API changes and uses.
> [...]
>
> More to the point, APIs aren't supposed to change in stable
> branches. That's one of the things that makes them "stable."
>

Right, but the counterpoint is that docs are supposed to document final
state and truth, and by scraping during a non-final dev time period, the
docs won't themselves be stable. So that's where the difficulty lies. :)
Anne


> --
> Jeremy Stanley
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>



-- 
Anne Gentle
annegentle at justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150508/21237f98/attachment.html>


More information about the OpenStack-docs mailing list