GenerateDocumentation

Package: kwave.devtools

Generate help documentation.

Syntax

kwave.devtools.GenerateDocumentation

Description

GenerateDocumentation is a static class that is called to generate the help files that appear in the MATLAB help browser and the documentation website. The documentation is generated in several stages:

1. The .m files in specified directories are converted directly to .html using the MATLAB publish function and to .md using the export function. Text should be written using MATLAB publishing markup, which is parsed as headings, code, etc.
2. The generated .html and .md files are modified to add links between related functions and classes.
3. A helptoc.xml file is automatically created, adding links to the generated .html files. Similarly, the appropriate SUMMARY.md files are generated in the appropriate file tree structure that contains the markdown files (ready to be turned into GitHub pages with mkdocs)
4. The documentation search database is created using builddocsearchdb.

This class is provided for generating documentation during development, and for preparing the documentation published on GitHub pages and packaged with a release. If you have downloaded a packaged release, there should be no need to call this class. However, if you have directly cloned the repository and are working with bleeding-edge changes, you can call GenerateDocumentation to (re-)generate the help files.