如何在Octave中记录功能？

Question

The publish function in MATLAB works for both scripts and functions, while the one for Octave works only for scripts: if I enter

publish myFunc.m

Octave gave

error: publish: Only Octave script files can be published.

Am I able to publish a function in Octave? If yes, how?

Answer 1

You can use Octave Forge generate_html package which is meant to generate html of individual functions. It is mostly used to generate the documentation of Octave Forge packages, and its defaults reflect that, but you could add any style you want.

This package will use the same help text that the help function in Octave sees which is the first block of comments in the file that does not start by Copyright or Author . You can have it in plain text but for nicer formatting, you can use Texinfo . In that case, the first line of the help text should be -*- texinfo -*- . There is a page on the Octave wiki with tips on how to write nice help text including a short section on Texinfo syntax (the actual Texinfo manual can be a bit overwhelming).

In addition to the help text, the generate_html package also identifies %!demo blocks and generates a section with the demo code and output it generates, including figures.

The best way to see how help text and demo blocks work in Octave is to check the source (as @Andy pointed out in the comments). For example, see the source for inpolygon (scroll to the bottom to find the %!demo blocks, right before %!test and %!error ). The generate_html package generates this page (note the Demonstration blocks).

Answer 2

This is a "multiple questions in one" question, making lots of assumptions in between, so let's address those first:

1. I'll start by the question in the comment, since that's the easiest: Matlab's publisher is not a code documentation tool. It's a "make a quick report that includes both text and code to show at your supervisor meeting or write a quick point in a blog" tool. So the link you point to is simply irrelevant in this case, since that talks about documentation for matlab code.

2. The fact that matlab's publisher also "works for functions", particularly given the first point here, should be considered to be more of a bug than a feature, or at most as a trivial undocumented extension. If you look at the matlab documentation for the publish command, you'll see it expects a filename, not a function with arguments, and the documentation only talks about scripts and makes no mention of 'function' compatibility.

3. Furthermore, even if you did want to use publisher as a "documentation tool", this is counterintuitive for functions in this format, since you need to provide arguments in order for publisher to work (which will not be shown in the actual report), you'll need a modified version that displays intermediate calculations (as opposed to your normal version which presumably does not), and the function just spews an ugly ans= blabla at the end of the report. If your end goal is documentation, it might be best to write a bespoke script for this anyway, showing proper usage and examples, like matlab does in its actual documentation.

---

Having said all that, yes, there is a 'cheat' you can do to include a function's code in your published report , which is that, in octave (also matlab since R2016b), functions can be defined locally. A .m file that only contains function definitions is interpreted as a function file, but if there are other non-function-declaration instructions preceding the function definitions (other than comments), then it is seen as a script. So if you publish this script, you effectively get a published report with function code in it:

%% Adding function
% This function takes an input and adds 5 to it.

%% Example inputs
In = 10;

%% The function itself
% Marvel at its beauty!
function Out = myfun(In)

  %% Here is where the addition takes place.
  % It is a beautiful addition
  Out = In + 5;

end

%% Example use
Out = myfun(In)

(If you're not happy about having to create a 'wrapper script' manually, you can always create your own wrapper function that does this automatically).

However, both the matlab and octave publishers are limited tools by design . Like I said earlier, it's more of a "quick report to show numbers and plots to your supervisor" tool, rather than a "make nice documentation or professional reports" tool. Instead, I would invest in a nice automated latex workflow, and have a look at code formatting tools for displaying code, and simply wrap that code in a script that produces output to a file that you can then import into latex. It may sound like more work, but it's a lot more flexible and robust in the long term, particularly since the formatting commands can be very quirky as well as limited.