Clear Filters
Clear Filters

Use a Live Script to document an APP?

6 views (last 30 days)
Chris on 23 Sep 2019
I am building a Matlab APP for my employer and as it grows in size, complexity and userbase I am seeing that it will need some form of referenceable documentation. As the APP is a GUI I would very much like to include screen shots or pictures of the APP and not just traditional Matlab text-based documentation. The APP (along with many other supporting mfiles) are within a central repository that coworkers occasionally pull from to update local working files.
Has anyone used Matlab Live Scripts to document something?
My thought would be to write the Live Script then publish it to HTML and then launch the HTML from within the APP as a call back when "help" is clicked.
Are there other better options than the use of Live Scripts for this? Getting coworkers to actively install something else can be a big ask so this should "just work" with no setup by the end user (adding new paths is about the limit I expect they will do as part of the setup...).
I dont expect the documentation to be more than ~20 pages with may pictures.

Answers (1)

Sahithi Kanumarlapudi
Sahithi Kanumarlapudi on 26 Sep 2019
The use of live scripts would be a good option for documentation. For more information on how to share live scripts refer to the following documentation.
The following page provides you good information on how to display custom documentation.


Find more on Develop Apps Using App Designer in Help Center and File Exchange

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!