导出自动生成Matlab文档到html [英] Export auto-generate Matlab doc to html

问题描述

我想为我开发的Matlab工具箱生成一个完整的帮助。

我已经看到了如何通过制作一个 helptoc.xml >文件，但是我不明白如何添加当您键入 doc My_class 时生成的页面。

是有一种方法将 doc My_class 的结果保存到具有属性和方法页面的所有链接的HTML页面？

解决方案

您可以使用 help2html ，这是没有很好的记录，但它的工作。

调用：

  html = help2html（mfilename）; 
  

逐字返回由 doc 作为1XN字符数组。 mfilename 是要记录的m文件的完整路径。虽然作为一个未记录的功能，它的界面不能保证保持不变，版权声明是从2008年起。所以看起来文件没有被经常触摸，你可能相信它继续工作一段时间。 p>


I want to generate a complete help for a Matlab toolbox I have developped.

I have seen how to Display custom documentation by making a helptoc.xml file, but I do not understand how you can add the pages generated when you type doc My_class.

Is there a way to save the result of doc My_class to HTML pages with all links for properties and methods pages?

解决方案

You can use help2html which is not very documented but it works.

Calling:

html = help2html(mfilename);

returns verbatim the HTML file that gets displayed by doc as a 1XN char array. mfilename is the full path to the m-file you want to document. Though as an undocumented function, its interface isn't guaranteed to stay constant, the copyright notice is from 2008. So it looks like the file isn't being touched often and you can probably trust it to keep working for a while.

这篇关于导出自动生成Matlab文档到html的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！