6.17 API for Staging Documentation Installs
| (require setup/doc-to-destdir) | package: racket-index |
The
setup/doc-to-destdir module provides support for
staging rendered documentation to better match the filesystem layout
of a package installation.
When the setup/doc-to-destdir module is run directly, such as with racket -l, it expects command-line arguments to pass along to move-rendered-docs-to-destdir. Provide the --help flag for more information.
Added in version 9.2.0.6 of package racket-index.
procedure
(move-rendered-docs-to-destdir dir doc-destdir) → void? dir : path-string? doc-destdir : path-string?
Scans dir for collections (typically within package
implementations) that specify documentation through a
"info.rkt" module, and where the specified documentation has
been rendered to a local "doc" subdirectory. The rendered
documentation is moved out of "doc" and into
doc-destdir. This movement imitates a raco setup step
of moving documentation that is already rendered within a collection
into a centralized directory for installation-scoped packages.
The move-rendered-docs-to-destdir function is intended for use in combination with raco pkg install --destdir, where dir is the same directory as provided after --destdir, and doc-destdir is an accompanying directory to be moved into place as rendered documentation instead of package implementation.