suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Revise Scribble docs for the new package system

Browse Source 
Replaced mentions of PLaneT with the new package system
in sec 4.1 of the Scribble docs.

original commit: 01ed4fa480cdf5f32e20459091778b75414389eb
This commit is contained in:
Asumu Takikawa 2014-03-14 10:22:12 -04:00
parent 1ef30a5715
commit 7c81ef7f75
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/how-to.scrbl
View File

@ -15,13 +15,14 @@ across documents.
@;---------------------------------------- @;----------------------------------------
@section[#:tag "setting-up"]{Setting Up Library Documentation} @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[ @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 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 remainder of these instructions assume that the file is called
@filepath{manual.scrbl}.} @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 @item{Run @exec{raco setup} to build your documentation. For a
collection, optionally supply @Flag{l} followed by the collection, optionally supply @Flag{l} followed by the
collection name to limit the build process to that collection name to limit the build process to that
collection. For a @|PLaneT| package, optionally supply collection.}
@Flag{P} followed by the package information to limit the
build process to that package.}
@item{The generated documentation is normally @item{The generated documentation is normally
@filepath{doc/manual/index.html} within the collection or @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 Racket's main @filepath{collects} directory, however, then the
documentation is generated as @filepath{manual/index.html} in documentation is generated as @filepath{manual/index.html} in
the installation's main @filepath{doc} directory.} the installation's main @filepath{doc} directory.}