[racket] rendered documentation in planet archive files

From: Robby Findler (robby at eecs.northwestern.edu)
Date: Tue May 8 12:23:31 EDT 2012

Looking at the source code to the server, I think the answer to that
is "yes", ie you get docs on the server when you include them in the
planet-docs subdirectory (necessary, not sufficient condition
naturally -- you need to set up the info.rkt to have a scribblings

And yes, I too believe the slowness when installing planet packages
has to do with the way scribble builds the documentation indicies. It
seems possible to fix this by having a separate, planet-only index
that will take time proportional to only the installed planet packages
on the system, not all of the docs (and thus be much faster), but no
one has looked into this seriously yet, I don't think.


On Tue, May 8, 2012 at 9:22 AM, Neil Van Dyke <neil at neilvandyke.org> wrote:
> I mean, for the interactive PLaneT Web site to have a working "docs" HTML
> link for a package version, must the uploaded PLaneT archive for that
> package version have contained a "planet-docs" subdir with the rendered HTML
> documentation?
> Anyone who has installed a PLaneT package knows the pain of waiting for
> documentation to render, even if rendered documentation is contained in the
> package archive file.  So I'm trying to see whether "planet-docs" in the
> package archive file is still used for any purpose, or I can leave it out.
> Neil Van Dyke wrote at 05/08/2012 10:05 AM:
>> For the PLaneT server to provide viewable documentation, does it rely on
>> the uploaded ".plt" archive file to contain a "planet-docs" subdirectory
>> containing the rendered documentation?
>> (I see that "make-planet-archive" will by default render any "scribblings"
>> documentation to subdir "planet-docs" in the archive.  I'm just checking
>> whether that's currently necessary, before I change my stuff to work better
>> with that.)
>> Thanks,
>> Neil V.
> ____________________
>  Racket Users list:
>  http://lists.racket-lang.org/users

Posted on the users mailing list.