On Thu, Jul 29, 2010 at 11:10 AM, Will Norris <span dir="ltr"><<a href="mailto:will@willnorris.com">will@willnorris.com</a>></span> wrote:<br><div class="gmail_quote"><blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
<br><br><div class="gmail_quote"><div><div></div><div class="h5">On Thu, Jul 29, 2010 at 11:01 AM, Will Norris <span dir="ltr"><<a href="mailto:will@willnorris.com" target="_blank">will@willnorris.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
<br><br><div class="gmail_quote"><div><div></div><div>On Thu, Jul 29, 2010 at 9:33 AM, Bill Shupp <span dir="ltr"><<a href="mailto:hostmaster@shupp.org" target="_blank">hostmaster@shupp.org</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
<div>On Wed, Jul 28, 2010 at 9:26 AM, Will Norris <span dir="ltr"><<a href="mailto:will@willnorris.com" target="_blank">will@willnorris.com</a>></span> wrote:<br></div><div class="gmail_quote"><div>
<blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
<br><br><div class="gmail_quote"><div>On Mon, Jul 26, 2010 at 3:45 PM, Nathan Hazout <span dir="ltr"><<a href="mailto:nathan.h@makemeheal.com" target="_blank">nathan.h@makemeheal.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
<div bgcolor="#ffffff" text="#000000">
OK here are the first few comments I have:<br>
<br>
- The readme says "You can view the HTML library documentation in
the doc/ directory." What doc directory? Could not find any ...<br>
(see issue #16 on github)<br></div></blockquote></div><div><br>When the libraries were hosted on <a href="http://openidenabled.com" target="_blank">openidenabled.com</a>, 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 (<a href="http://www.phpdoc.org/" target="_blank">http://www.phpdoc.org/</a>). Instructions on how to exactly do that is definitely something we need to document. <br>
</div></div></blockquote></div><div><br>Will,<br><br>I saw that someone created <a href="http://openid.github.com" target="_blank">http://openid.github.com</a>. 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 <a href="http://openid.github.com" target="_blank">openid.github.com</a> repo. I'd be happy to host the cron job on my VPS as well.<br>
</div></div></blockquote></div></div><div><br>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<br>
<br> <a href="http://openid.github.com/php/docs/%7Bversion%7D/" target="_blank">http://openid.github.com/php/docs/{version}/</a><br> <a href="http://openid.github.com/python/docs/%7Bversion%7D/" target="_blank">http://openid.github.com/python/docs/{version}/</a><br>
<a href="http://openid.github.com/ruby/docs/%7Bversion%7D/" target="_blank">http://openid.github.com/ruby/docs/{version}/</a><br><br>sound for the auto-generated docs? Probably can just start with the latest version and go from there.<br>
</div></div></blockquote></div></div><div><br>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 :)<br>
<br></div></div></blockquote><div><br><br>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.<br>
<br>Cheers,<br><br>Bill<br></div></div>