[Openstack-docs] New Python API guide
Lorin Hochstein
lorin at nimbisservices.com
Sun Oct 27 03:01:41 UTC 2013
Yeah, I'm not sure if this belongs in the "api" docs or not. The Python API
is a different beast from the REST API. I see this as more of a guide for
Python programmers.
Also, I think the definitive reference for all of the relevant Python
classes and functions should be the Sphinx-generated
http://docs.openstack.org/developer/python-*client/ sites (although if the
RST->DocBook stuff gets done, then these can be slurped in). I'd really
like to see the quality of these improved and made consistent across the
projects. I think the keystoneclient one is probably the best one right now.
Lorin
On Sat, Oct 26, 2013 at 10:49 PM, Diane Fleming <diane.fleming at rackspace.com
> wrote:
> I have to look more closely - it definitely looks good but I have to see
> where it fits with the API docs blueprint.
>
> Sent from my iPhone
>
> On Oct 26, 2013, at 8:14 PM, "Anne Gentle" <annegentle at justwriteclick.com>
> wrote:
>
> How about putting it in openstack/api-site?
>
> Diane, how does this look for the API Blueprint you've been drafting?
>
> Anne
>
>
> On Fri, Oct 25, 2013 at 10:28 PM, Lorin Hochstein <
> lorin at nimbisservices.com> wrote:
>
>> Hi doc'ers:
>>
>> I've just submitted a patch for a new Python API guide:
>> https://review.openstack.org/#/c/52857/
>>
>> I've done it in asciidoc, following the same scheme of the HA guide.
>> There's a makefile included that will convert it to DocBook, as well as
>> invoke maven to generate the final product.
>>
>> It's not complete yet (for example, the Cinder chapter is currently
>> empty), but I think there's enough there that it would be useful to readers
>> in its current form.
>>
>> Let me know what you think.
>>
>> If this gets accepted, I'll need some assistance in setting up the
>> relevant infrastructure jobs so this guid gets deployed to
>> docs.openstack.org.
>>
>> Lorin
>> --
>> Lorin Hochstein
>> Lead Architect - Cloud Services
>> Nimbis Services, Inc.
>> www.nimbisservices.com
>>
>> _______________________________________________
>> 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
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>
--
Lorin Hochstein
Lead Architect - Cloud Services
Nimbis Services, Inc.
www.nimbisservices.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20131026/0060e829/attachment.html>
More information about the Openstack-docs
mailing list