Publish dependent and called functions

Publish explicitly called functions not found in the MATLAB root. See mfile for limitations.

Description

  publishdepfun creates a single published html file with called
  functions attached to the end of the root mfile. Hyperlinks will be
  within a "Called Functions" in the Table of Contents area of the
  published document that link to the called function. Functions that are
  called that are under MATLABROOT are not included in the published
  output.
 
  publishdepfun only goes one level deep....
  
  Example: If fun1 calls fun2, fun2 will be published. If fun2 calls fun3,
           fun3 will not be published.
 
  Calling: new_doc = publishdepfun(func,opts)
  
  Inputs:
 
  * func => character string of root function or script ('Function1').
            The ".m" is not needed.
  * opts => is the list of options for the publishing. See publish.m help
            for more information.
 
  Outputs:
 
  * new_doc => the final html document with attached subfunctions.
                    Name is the root file name with "_withfuncs" appended.

• Required Products: MATLAB
• MATLAB release: MATLAB 7.13 (2011b)

[Jiro Doke]

Very nice entry Nick!

This may be about preference, but it would be nice if I call the function without any output argument, then it would open the published HTML in the MATLAB browser. This is the same behavior as "publish".

Otherwise, I really like it. I plan on highlighting this entry for this week's Pick of the Week.

Thanks for the submission!

[Nick Angelini]

@Jiro

I have added some crude support for displaying the html document when no output argument is given. I just used nargout. Is there a more elegant solution?

[Mikhail]

Thanks!

However, it also includes my called MEX functions into the generated report (which looks kinda weird in the report).

I added the following around line 95 to mitigate this particular behavior:

%% Remove hits that are probably MEX functions
idx=strfind(out,mexext);
for i=1:length(idx),
    idxs(i) = ~isempty(idx{i});
end
out(idxs)=[];

[Nick Angelini]

Mikhail,

Thanks for finding that. I have added it to the file and have submitted the updated version.

[Arvind]

Thanks Nick... This is exactly what I needed

[Jiro Doke]

@Nick,

Thanks for adding the web output in case of no output argument. "nargout" is the appropriate way to deal with that.