<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
</head>
<body bgcolor="#FFFFFF" text="#000000">
Hello,<br>
<br>
I'm a little confused with regard to how to document packages and
collections<br>
within them, and how to access that documentation when installing a
package.<br>
<br>
I have been working on a package:<br>
<a href="https://pkg.racket-lang.org/info/xdgbasedir">https://pkg.racket-lang.org/info/xdgbasedir</a><br>
<br>
Which has the repository hosted on github:<br>
<a class="moz-txt-link-freetext" href="https://github.com/LawrenceWoodman/xdgbasedir_rkt">https://github.com/LawrenceWoodman/xdgbasedir_rkt</a><br>
<br>
When the package above was on PLaneT I could easily create
scribblings for it,<br>
point to them from the info.rkt and view those rendered docs
on-line.<br>
However, with the package system, even though I have kept the
info.rkt and<br>
scribblings under the collection, I can't see a straightforward way
of accessing<br>
that rendered documentation. I'm also finding that when raco setup
is being<br>
called as part of the installation of a package that it is
complaining that info.rkt has<br>
no info for scribblings, but the package management metadata doesn't
say that the<br>
manager uses the scribblings def.<br>
<meta http-equiv="content-type" content="text/html;
charset=ISO-8859-1">
<a href="http://docs.racket-lang.org/pkg/metadata.html">http://docs.racket-lang.org/pkg/metadata.html</a><br>
<br>
So I have a few questions:<br>
i. Should I put a scribblings entry in the package's info.rkt?<br>
ii. If I do put a scribblings entry in the package's info.rkt,
how should I separate<br>
the documentation between the package and the collection?
i.e. Should<br>
I have a scribblings entry for each collection's info.rkt and
one for the package's<br>
as well?<br>
iii. How can I access the rendered documentation, without having
to manually<br>
navigate to the directory the package was installed in and
find the doc/<br>
directory?<br>
<br>
Thanks<br>
<br>
<br>
Lawrence Woodman<br>
<br>
<br>
<pre class="moz-signature" cols="72">--
vLife Systems Ltd
Registered Office: The Meridian, 4 Copthall House, Station Square, Coventry, CV1 2FL
Registered in England and Wales No. 06477649
<a class="moz-txt-link-freetext" href="http://vlifesystems.com">http://vlifesystems.com</a>
</pre>
</body>
</html>