[Code] GitHub Pull Requests for php-openid

[Will Norris]

On Thu, Jul 29, 2010 at 2:15 PM, Bill Shupp <hostmaster at shupp.org> wrote:

> On Thu, Jul 29, 2010 at 11:10 AM, Will Norris <will at willnorris.com> wrote:
>
>>
>>
>> On Thu, Jul 29, 2010 at 11:01 AM, Will Norris <will at willnorris.com>wrote:
>>
>>>
>>>
>>> On Thu, Jul 29, 2010 at 9:33 AM, Bill Shupp <hostmaster at shupp.org>wrote:
>>>
>>>> On Wed, Jul 28, 2010 at 9:26 AM, Will Norris <will at willnorris.com>wrote:
>>>>
>>>>>
>>>>>
>>>>> On Mon, Jul 26, 2010 at 3:45 PM, Nathan Hazout <
>>>>> nathan.h at makemeheal.com> wrote:
>>>>>
>>>>>>  OK here are the first few comments I have:
>>>>>>
>>>>>> - The readme says "You can view the HTML library documentation in the
>>>>>> doc/ directory." What doc directory? Could not find any ...
>>>>>> (see issue #16 on github)
>>>>>>
>>>>>
>>>>> When the libraries were hosted on openidenabled.com, JanRain used a
>>>>> release script to actually build the release.  This include, among other
>>>>> things, generating the docs.  When you check the code directly out of
>>>>> github, you have to generate the docs yourself using phpdoc (
>>>>> http://www.phpdoc.org/).  Instructions on how to exactly do that is
>>>>> definitely something we need to document.
>>>>>
>>>>
>>>> Will,
>>>>
>>>> I saw that someone created http://openid.github.com.  Maybe the docs
>>>> could be displayed there.  I'd be happy to help with this effort - write a
>>>> cron job to monitor the main repo, and rebuild docs upon changes, and put
>>>> them in the openid.github.com repo.  I'd be happy to host the cron job
>>>> on my VPS as well.
>>>>
>>>
>>> yeah, I went ahead and set that up as a placeholder.  I would love to
>>> have some help fleshing that out... I'll add you to the repository.  Maybe
>>> for now just get the generated API docs up... how does
>>>
>>>   http://openid.github.com/php/docs/{version}/<http://openid.github.com/php/docs/%7Bversion%7D/>
>>>   http://openid.github.com/python/docs/{version}/<http://openid.github.com/python/docs/%7Bversion%7D/>
>>>   http://openid.github.com/ruby/docs/{version}/<http://openid.github.com/ruby/docs/%7Bversion%7D/>
>>>
>>> sound for the auto-generated docs?  Probably can just start with the
>>> latest version and go from there.
>>>
>>
>> err, now that I read your email again, sounds like you were looking more
>> at building the docs for whatever code is in HEAD.  Actually, that's good to
>> have too... maybe with a version of 'latest', like PEAR does.  I think
>> should still have docs for the tagged releases, but we can do those manually
>> since they won't need to be updated.  At some point, I'd love to go back and
>> add tags for some of the older releases (we only have the last couple tagged
>> in github), but that's for another day :)
>>
>>
>
> I went ahead and generated the PHP docs for now for Nathan.  I'll get the
> python and ruby ones generated once I figure out those tools, as well as get
> everything versioned and automated.
>

done. :)  http://openid.github.com/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openid.net/pipermail/openid-code/attachments/20100729/2d8c8a7c/attachment.html>