How to make the doc visible in the file exchange after git hub connexion ?

1 次查看（过去 30 天）

Nicolas Douillet 2020-7-8

2
链接

此问题的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/561740-how-to-make-the-doc-visible-in-the-file-exchange-after-git-hub-connexion

评论： Rik 2020-9-25

Hi,

After I connected my mesh_processing_toolbox, to Git hub its documentation is no longer visible in the "Examples" tab (it was before).

I didn't change anything, to the package.

Anyone know how I could fix this. The documentation matters.

Thank you for help.

Best,

Nicolas

11 个评论
显示 9更早的评论隐藏 9更早的评论

Rik 2020-7-8

编辑：Rik 2020-7-8

在 MATLAB Online 中打开

It would be really helpful if how to properly document a FEX was better documented. From what I just tried to figure out, you need an HTML file with the same name as your m-file in an 'html' subdirectory. However, there doesn't seem to be a good way to get this HTML file, so you can use something like this:

function publish_help(fun_name,varargin)
if nargin==0,fun_name='MyFun';end
[~,fun_name]=fileparts(fun_name);%remove .m
s=help(fun_name);
txt=strsplit(s,char(10)); %#ok<CHARTEN>
while numel(txt{end})==0,txt(end)=[];end%remove empty lines at the end
[~,fn]=fileparts(tempname);
fid=fopen([fn '.m'],'w');
for n=1:numel(txt)
    if n==numel(txt),newline='';else,newline='\n';end
    line=txt{n};
    fprintf(fid,['%%%s' newline],line);
end
fclose(fid);
publish(fn,varargin{:});
delete([fn '.m']);
movefile(['html' filesep fn '.html'],['html' filesep fun_name '.html']);
end

I really hope the solution isn't to move everything over to mlx. That would break so many things. I would really prefer not to have an additional step of adding an mlx copy just to get this tab to work.

Stephen23 2020-9-25

"...having more options for the layout would be nicer..."

Perhaps this might help: https://www.mathworks.com/matlabcentral/fileexchange/78059-prettify-matlab-html

Rik 2020-9-25

Thanks for the suggestion, I will look into it.

请先登录，再进行评论。

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

采纳的回答

Nicolas Douillet 2020-7-9

0
链接

此回答的直接链接

https://ww2.mathworks.cn/matlabcentral/answers/561740-how-to-make-the-doc-visible-in-the-file-exchange-after-git-hub-connexion#answer_463229

To answer the question : after looking at the other file exchange contributors I figured out it has to be in .mlx format.

I still have to try, and will be back here to validate.

2 个评论
显示无隐藏无

Rik 2020-7-9

I really hope this answer is not correct. I can't add a .mlx placeholder to my submissions, because mlx has a higher precedence level than m.

And it contradicts the FEX documentation, but that might just be a lack of updating.

Nicolas Douillet 2020-8-15

编辑：Nicolas Douillet 2020-8-15

Ok Rik, so I did it here for example.

I named it my_function_name_ls.mlx as you can see.

This way I have not a doc, but some illustrated examples, let's say. The doc is however well included in the package as you can see in the Github.

The only thing is that in the examples tab I have in first position this file with my function name and no preview available.

请先登录，再进行评论。

类别

MATLAB Environment and Settings

在 Help Center 和 File Exchange 中查找有关 Environment and Settings 的更多信息

Community Treasure Hunt

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

Start Hunting!

Translated by