suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add a note about how to build documentation to the planet documentation building step

Browse Source
This commit is contained in:
Robby Findler 2012-08-18 09:03:35 -05:00
parent 47cb06f842
commit ec34fc6870
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
collects/planet/planet.scrbl
View File

@ -554,6 +554,11 @@ numbers in documentation for @|PLaneT| packages, and
@other-manual['(lib "scribblings/scribble/scribble.scrbl")] @other-manual['(lib "scribblings/scribble/scribble.scrbl")]
for instructions on how to write Scribble documentation. for instructions on how to write Scribble documentation.
When testing your documentation, set up a development link and use
@centered{@tt{raco setup -P <owner> <package-name> <maj> <min>}}
with arguments based on the development link to build and
test your documentation.
@italic{Note:} Always use @racket[this-package-in] in @racket[for-label] @italic{Note:} Always use @racket[this-package-in] in @racket[for-label]
bindings when documenting @|PLaneT| packages, and always use the bindings in bindings when documenting @|PLaneT| packages, and always use the bindings in
@racketmodname[planet/scribble] rather than @racketmodname[scribble/manual]. @racketmodname[planet/scribble] rather than @racketmodname[scribble/manual].