MATLAB Answers

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

16 views (last 30 days)
Nicolas Douillet
Nicolas Douillet on 8 Jul 2020
Commented: Rik on 25 Sep 2020 at 6:11
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 Comments

Show 8 older comments
Rik
Rik on 9 Jul 2020
My use-case is to have an HTML documentation page. And you're correct that none of my submissions currently have that.
Using doc('MyFunction') is nice, but having more options for the layout would be nicer, and the publishing tool looked to me like it is supposed to do that.

Sign in to comment.

Accepted Answer

Nicolas Douillet
Nicolas Douillet on 9 Jul 2020
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 Comments

Rik
Rik on 9 Jul 2020
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
Nicolas Douillet on 15 Aug 2020
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.

Sign in to comment.

More Answers (1)

Nicolas Douillet
Nicolas Douillet on 24 Sep 2020 at 19:34
Ok, I actually still have the same problem (preview not available for documentations one connected to Github).
My live scripts are visible, but they are not equivalent to file documentation.
Thank you for any help / tip.
Nicolas

  1 Comment

Rik
Rik on 24 Sep 2020 at 20:39
I have made a Mathworks employee aware of this issue when I happened to have contact, and I'm sure that person has forwarded that bug-report to the appropriate team. My personal estimate is that it will take until the next big update to the FEX until it is solved.

Sign in to comment.

Community Treasure Hunt

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

Start Hunting!