commit 7c81ef7f75cb6da352a71a312f6c3646aafcc06c
parent 1ef30a57153c5081f7e06f3f5f68f421430f8af1
Author: Asumu Takikawa <asumu@ccs.neu.edu>
Date: Fri, 14 Mar 2014 10:22:12 -0400
Revise Scribble docs for the new package system
Replaced mentions of PLaneT with the new package system
in sec 4.1 of the Scribble docs.
original commit: 01ed4fa480cdf5f32e20459091778b75414389eb
Diffstat:
1 file changed, 6 insertions(+), 7 deletions(-)
diff --git a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/how-to.scrbl b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/how-to.scrbl
@@ -15,13 +15,14 @@ across documents.
@;----------------------------------------
@section[#:tag "setting-up"]{Setting Up Library Documentation}
-To document a collection or @|PLaneT| package:
+To document a collection or Racket
+@seclink["getting-started" #:doc '(lib "pkg/scribblings/pkg.scrbl") "package"]:
@itemize[
- @item{Create a file in your collection or planet package with the
+ @item{Create a file in your collection or package with the
file extension @filepath{.scrbl}. Beware that the file name
- you choose will determine the output directory's name. The
+ you choose will determine the output file's name. The
remainder of these instructions assume that the file is called
@filepath{manual.scrbl}.}
@@ -63,13 +64,11 @@ To document a collection or @|PLaneT| package:
@item{Run @exec{raco setup} to build your documentation. For a
collection, optionally supply @Flag{l} followed by the
collection name to limit the build process to that
- collection. For a @|PLaneT| package, optionally supply
- @Flag{P} followed by the package information to limit the
- build process to that package.}
+ collection.}
@item{The generated documentation is normally
@filepath{doc/manual/index.html} within the collection or
- @|PLaneT| package directory. If the collection is in
+ package directory. If the collection is in
Racket's main @filepath{collects} directory, however, then the
documentation is generated as @filepath{manual/index.html} in
the installation's main @filepath{doc} directory.}