Function File: index = txi2index (file_pattern)

Convert .txi files in the Octave source into an INDEX structure suitable for generating a functon reference.

file_pattern must be a string containing either the name of a .txi file, or a pattern for globbing a set of files (e.g. "*.txi"). The resulting cell array index contains a set of structures corresponding to those generated by pkg ("describe"). These structures can then be given to generate_package_html to produce HTML content.

As an example, if the Octave source code is located in ~/octave_code, then this function can be called with

octave_source_code = "~/octave_code";
index = txi2index (fullfile (octave_source_code, "doc/interpreter", "*.txi"));

See also: pkg, generate_package_html.

Package: generate_html