A library for generating SXML docs from Scribble, directly or extracted from literate docs.
Replace ansi escape sequences in a str
with the corresponding sxml.
Extract the literate Scribble docs for module mod-name
and
print them to out
, rendered with render
which defaults
to sxml-display-as-text
.
Extract the literate Scribble docs for just the binding for
var
in module mod-name
, and print them as in
print-module-docs
.
Extract the literate Scribble docs for proc
which should be
a procedure and return them as sxml.
Extract the literate Scribble docs for proc
which should be
a procedure and render them as in print-module-docs
.
Return a new document environment suitable for passing to
expand-docs
, with default rules for sections, code
blocks, procedure and macro signatures, etc.
Return a new document environment as in
make-default-doc-env
, with an example-env
binding mapped to an environment importing (scheme base)
and the module mod-name
. This binding is used when
expanding examples in the docs.
Given the sxml document sxml
, expands macros defined in the
document environment env
into standard html tags.
Resolves paragraphs and adds a header to convert sxml
to a
standalone document renderable in html.
Composes expand-docs
and fixup-docs
.
Extract inline Scribble documentation (with the ;;> prefix) from
the source file file
, associating any signatures from the
provided defs when available and not overridden in the docs.
Extract the literate Scribble docs from module mod-name
and
return them as sxml. If strict?
is true ignore docs for
unexported values, defined by the optional exports
which
defaults to all the module exports.
As above, but extracts docs for the module defined in file
,
which need not be in the search path.