Generate searchable documentation for MATLAB Packages(Namespaces) and Classes

12 次查看（过去 30 天）
ILoveMATLAB
ILoveMATLAB 2019-5-20
编辑： ILoveMATLAB 2019-5-21
Is there a way to generate searchable static documentation for several packages (namespaces) created in MATLAB? I have about 10 packages that contain several classes and function. Therefore, the procedure needs to work for classes.
Follow Up Question.
If static documentation cannot be generated, how can I use builddocsearchdb? According to the documentation, I need to create my own html files. I tried using publish to generate html documentation for each class I created; however, publish does not produce the expected result.
I have considered other options; however, those options will not work for me.
  • sphinxcontrib-matlabdomain
Requires me and anyone who maintains my program to learn python
My company blocks users from installing packages via conda and pip.
  • M2HTML
not searchable
Per r Rik's request here are several examples of searchable documentation:
https://www.mathworks.com/help/matlab/
https://docs.opencv.org/2.4.13.7/
https://scikit-image.org/docs/stable/
http://accord-framework.net/docs/html/R_Project_Accord_NET.htm

请先登录，再回答此问题。

回答（1 个）

Sean de Wolski
Sean de Wolski 2019-5-20
I've always exported the html from the autogenerated doc page:
doc mypack.myclass
Or written a Live Script that documents the class, provides examples, etc. and then exported this to html to be incorporated with builddocsearchdb. The second method is generally my preferred method.
  1 个评论
ILoveMATLAB
ILoveMATLAB 2019-5-21
编辑：ILoveMATLAB 2019-5-21
Sean,
How do I save/export the auto-generated doc page to HTML? I do not see an option in 2018b.
Is there a method that automatically generates html documentation for all files in a given directory?Please note that all of my classes are documented using the doc format.
https://www.mathworks.com/help/matlab/matlab_prog/create-help-for-classes.html
Your second option does not scale well for large projects. I don't have time to document every class/function twice. Nevertheless, this option would be useful for adding tutorials to my documentation.

请先登录，再进行评论。

类别

在 Help Center 和 File Exchange 中查找有关 Java Package Integration 的更多信息

标签

产品


版本

R2018b

Community Treasure Hunt

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

Start Hunting!

Translated by