6.17 API for Staging Documentation Installs

► |  | raco: Racket Command-Line Tools

1 | raco make: Compiling Source to Bytecode
2 | raco exe: Creating Stand-Alone Executables
3 | raco distribute: Sharing Stand-Alone Executables
4 | raco planet: Automatic Package Distribution
5 | raco pkg: Package Management
6 | raco setup: Installation Management
7 | raco decompile: Decompiling Bytecode
8 | raco demod: Demodularizing Programs
9 | raco link: Library Collection Links
10 | raco pack: Packing Library Collections
11 | raco unpack: Unpacking Library Collections
12 | raco ctool: Working with C Code
13 | raco test: Run tests
14 | raco docs: Documentation Search
15 | raco expand: Macro Expansion
16 | raco read: Reading and Pretty-Printing
17 | raco scribble: Building Documentation
18 | Adding a raco Command
19 | Installation Configuration and Search Paths

▼ | 6 | raco setup: Installation Management

6.1 | Running raco setup
6.2 | Installing ".plt" Archives
6.3 | Controlling raco setup with "info.rkt" Files
6.4 | "info.rkt" File Format
6.5 | Package Dependency Checking
6.6 | API for Setup
6.7 | API for Installing ".plt" Archives
6.8 | API for Finding Installation Directories
6.9 | API for Reading "info.rkt" Files
6.10 | API for Relative Paths
6.11 | API for Collection Names
6.12 | API for Collection Searches
6.13 | API for Platform Specifications
6.14 | API for Cross-Platform Configuration
6.15 | API for Cross-References for Installed Manuals
6.16 | API for Materializing User-Specific Documentation
6.17 | API for Staging Documentation Installs
6.18 | Layered Installations
6.19 | Tethered Installations

On this page:

move-rendered-docs-to-destdir

Racket
top contents ← prev up next →

### 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.

top contents ← prev up next →