% -*- texinfo -*-
% @deftypefn {Function File} generate_package_html (@var{name}, @var{outdir}, @var{options})
% Generate @t{HTML} documentation for a package.
%
% The function reads information about package @var{name} using the
% package system. This is then used to generate bunch of
% @t{HTML} files; one for each function in the package, and one overview
% page. The files are all placed in the directory @var{outdir}, which defaults
% to the current directory. The @var{options} structure is used to control
% the design of the web pages.
%
% As an example, the following code generates the web pages for the @t{image}
% package, with a design suitable for the @t{Octave-Forge} project.
%
% @example
% options = get_html_options ('octave-forge');
% generate_package_html ('image', 'image_html', options);
% @end example
%
% The resulting files will be available in the @t{'image_html'} directory. The
% overview page will be called @t{'image_html/image_overview.html'}.
%
% As a convenience, if @var{options} is a string, a structure will
% be generated by calling @code{get_html_options}. This means the above
% example can be reduced to the following.
%
% @example
% generate_package_html ('image', 'image_html', 'octave-forge');
% @end example
%
% It should be noted that the function only works for installed packages.
% @seealso{get_html_options}
% @end deftypefn