6.16 API for Materializing User-Specific Documentation
| (require setup/materialize-user-docs) | |
| package: racket-index | |
Added in version 1.1 of package racket-index.
procedure
(materialize-user-docs [ on-setup #:skip-user-doc-check? skip-user-doc-check?]) → void?
on-setup : ((-> boolean?) . -> . any) = (lambda (setup) (setup)) skip-user-doc-check? : any/c = #f
Checks whether a user-specific documentation entry point already
exists in (find-user-doc-dir), and if not, runs raco
setup in a mode that will create the entry point (to have the same
content as the installation’s documentation entry point.) If
skip-user-doc-check? is not #f, then skips the
check for the user-specific documentation entry point.
The run of raco setup is packaged in a thunk that is provided to on-setup, which can adjust the current output and error ports as appropriate and check the thunk’s result for success.
The on-setup argument is not called if the documentation entry point already exists in (find-user-doc-dir).
Changed in version 1.1 of package racket-index: Added the skip-user-doc-check? argument.