Routines to generare stexi
documentation for objects and modules.
Note that in this context, an object is just a value associated with a location. It has nothing to do with GOOPS.
Return documentation for the module named sym-name. The
documentation will be formatted as stexi
(see texinfo).
Return documentation for given script. The documentation will be taken
from the script’s commentary, and will be returned in the stexi
format (see texinfo).
Create a standard texinfo copying
section.
years is a list of years (as integers) in which the modules being documented were released. All other arguments are strings.
Create a standard GNU title page.
authors is a list of (name . email)
pairs. All
other arguments are strings.
Here is an example of the usage of this procedure:
(package-stexi-standard-titlepage "Foolib" "3.2" "26 September 2006" '(("Alyssa P Hacker" . "alyssa@example.com")) '(2004 2005 2006) "Free Software Foundation, Inc." "Standard GPL permissions blurb goes here")
Create a menu from a generic alist of entries, the car of which should
be the node name, and the cdr the description. As an exception, an entry
of #f
will produce a separator.
Create a standard top node and menu, suitable for processing by makeinfo.
Create an "extended" menu, like the standard menu but with a section for scripts.
Create a standard prologue, suitable for later serialization to texinfo and .info creation with makeinfo.
Returns a list of stexinfo forms suitable for passing to
package-stexi-documentation
as the prologue. See texinfo reflection package-stexi-documentation, package-stexi-standard-titlepage,
package-stexi-standard-copying, and
package-stexi-standard-menu.
Create stexi documentation for a package, where a package is a set of modules that is released together.
modules is expected to be a list of module names, where a module name is a list of symbols. The stexi that is returned will be titled name and a texinfo filename of filename.
prologue and epilogue are lists of stexi forms that will be spliced into the output document before and after the generated modules documentation, respectively. See texinfo reflection package-stexi-standard-prologue, to create a conventional GNU texinfo prologue.
module-stexi-documentation-args is an optional argument that, if
given, will be added to the argument list when
module-texi-documentation
is called. For example, it might be
useful to define a #:docs-resolver
argument.
Create stexi documentation for a package, where a package is a set of modules that is released together.
modules is expected to be a list of module names, where a module name is a list of symbols. Returns an stexinfo fragment.
Unlike package-stexi-documentation
, this function simply produces
a menu and the module documentations instead of producing a full texinfo
document. This can be useful if you write part of your manual by hand,
and just use @include
to pull in the automatically generated
parts.
module-stexi-documentation-args is an optional argument that, if
given, will be added to the argument list when
module-texi-documentation
is called. For example, it might be
useful to define a #:docs-resolver
argument.