suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

make scribble' (and raco scribble') use a `doc' submodule when present

Browse Source 
original commit: f60803c300e5c208d80b8e2567a2622f114758b5
This commit is contained in:
Matthew Flatt 2013-05-05 10:19:41 -06:00
parent e2578af0ef
commit 9097b87aca
2 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
collects/scribble/run.rkt
View File

@ -105,7 +105,11 @@
(current-quiet #t)] (current-quiet #t)]
#:args (file . another-file) #:args (file . another-file)
(let ([files (cons file another-file)]) (let ([files (cons file another-file)])
(build-docs (map (lambda (file) (dynamic-require `(file ,file) 'doc)) (build-docs (map (lambda (file)
;; Try `doc' submodule, first:
(if (module-declared? `(submod (file ,file) doc) #t)
(dynamic-require `(submod (file ,file) doc) 'doc)
(dynamic-require `(file ,file) 'doc)))
files) files)
files)))) files))))

13
collects/scribblings/scribble/running.scrbl
View File

@ -51,9 +51,16 @@ flag to specify a destination directory (for any number of source
files). Use @DFlag{dest-base} to add a prefix to the name of each files). Use @DFlag{dest-base} to add a prefix to the name of each
support file that is generated or copied to the destination. support file that is generated or copied to the destination.
After all flags, provide one or more document sources. When multiple After all flags, provide one or more document sources, where each
documents are rendered at the same time, cross-reference information source declares a module. The module should either have a @racket[doc]
in one document is visible to the other documents. See @tech[#:doc '(lib "scribblings/reference/reference.scrbl")]{submodule}
that exports @racket[doc] as a @racket[part], or it should directly
export @racket[doc] as a @racket[part]. (The submodule is tried first,
and the main module is not directly loaded or evaluated if the
submodule can be loaded on its own.)
When multiple documents are rendered at the same time, cross-reference
information in one document is visible to the other documents. See
@secref["xref-flags"] for information on references that cross @secref["xref-flags"] for information on references that cross
documents that are built separately. documents that are built separately.