Re: [Chicken-hackers] Distributed egg repo proposal

[John Gabriele]

On Tue, Mar 15, 2011 at 3:06 AM, Jim Ursetto <address@hidden> wrote:
>
> On Mar 14, 2011, at 10:12 PM, John Gabriele wrote:
>
>> 2. *Documentation*. Python's
>> [Cheeseshop](http://cheeseshop.python.org) has a neat feature where,
>> if your project has html documentation, you can (manually) upload it
>> directly to http://packages.python.org/project-name . {snip}
>
> {snip}
>
> Python has docstrings, Chicken doesn't.

Hi Jim,

The Python package docs at packages.python.org/package-name (and not
many packages are actually making use of the doc hosting) are not
generally generated from docstrings (though they could be). Folks in
the Python community often use [Sphinx] to generate html docs from
[ReST] -formatted text files.

[Sphinx]: http://sphinx.pocoo.org/
[ReST]: http://docutils.sourceforge.net/rst.html

I think Ruby has something similar for docs at rubyforge.

Incidentally, Perl's CPAN Search http://search.cpan.org/ is of course
the one that extracts and generates docs from embedded (POD)
documentation. It also allows developers to have straight .pod files
in their package which get rendered as html as well.

---John