On the online developer meeting there was a discussion about creating a function reference.
Finally, I managed to get the one hosted on Octave Forge back to work by forking and fixing the generate_html-package, see
I think this is a way to go. The outputs look already promising:
It boils down to
generate_html_manual ("/path/to/octave", "htdocs", ... get_html_options ("octave-forge"));
and a 30 minutes coffee break
Thanks to all the creators and maintainers of that package, that it still works “nicely” after only a few bug fixes
My next steps will be to revisit this package thoroughly, especially update the layout a bit
On the Octave side, there are several interactive demos that need to be avoided to run this documentation generation fully automated:
fun = linkprop Press <enter> to link plots: Press <enter> to change color: Press <enter> to change linestyle: fun = linkaxes Press <enter> to link axes: Press <enter> to change ylim: fun = colormap Press a key to continue fun = uigetdir fun = uigetfile fun = uiputfile Several more widgets
Is there a way to avoid executing those demos?
Another issue is, that the list of indexed functions is generated from the current Octave user manual.
The categories extracted, which is to my plans for the project not desirable to preserve. An alphabetical list of functions might be a good start, as I don’t find the 160 flattened TOC headline categories very helpful in finding a particular function. Opinions?
Is there a way to list all all Octave functions?
If someone is interested in this project too, help is always welcome