How can I generate HTML documentation from help/doc output?
46 views (last 30 days)
Show older comments
How can I automatically generate reference HTML documentation for my toolbox (mostly classdef classes)? I'm looking for something like what the doc command produces, pulling help text and class properties, methods, etc. from the source files directly, but outputing a set of HTML files I can host on my web-site as a reference manual.
I'm aware of M2HTML (does not handle classdef) and Sphinx+sphinxcontrib.matlab (multiple issues with classdef files), but nothing that handles the MathWorks recommended style of class documentation directly. I've even tried the undocumented help2html, but don't know how to get it to include links.
What does everyone else do? Write your documentation twice? Once in the source files for use with help and doc, and then again, manually reproducing everything for your online reference documentation?
0 Comments
Answers (2)
Ray Zimmerman
on 15 Sep 2023
2 Comments
Grzegorz Lippe
on 24 Nov 2023
Where can I find help for this package?
I tried it, but it only produced an emtpy index.html template.
Yash Sharma
on 13 Sep 2023
Hi Ray,
I understand that you want to create HTML documentation for your toolbox that mostly have “classdef” classes.
You can use the publish button that is there on the publish tab in MATLAB or you can use the following code to generate HTML documentation.
% Specify the file or files to include in the documentation
fileToPublish = 'MyClass.m';
% Specify the output format and directory
outputFormat = 'html';
outputDir = 'output/docs';
% Generate the documentation
publish(fileToPublish, 'format', outputFormat, 'outputDir', outputDir);
Please find links to below documentation which I believe will help you for further reference.
- Publish: https://www.mathworks.com/help/matlab/ref/publish.html
- Display Custom Documentation for toolbox: https://www.mathworks.com/help/matlab/matlab_prog/display-custom-documentation.html
See Also
Categories
Find more on Startup and Shutdown 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!