6.16 API for Materializing User-Specific Documentation

► |  | 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:

materialize-user-docs

Racket
top contents ← prev up next →

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

top contents ← prev up next →