pkg-octave-doc
0.8.2 2026-09-04This package provides functions for generating HTML pages that contain the help texts of the functions of an octave package. The package is designed to work with installed packages and use their INDEX file for creating the respective functions' HTML pages. The default layout is based on bootstrap 5 and it follows the design of the Octave Packages GitHub page. Besides the HTML pages, the package also builds the Qt help file read by the GUI documentation tab and the doc-cache searched by lookfor, both from the same texinfo help texts.
Select Category:
Documentation
build_DEMOS
|
Build notebook-style HTML for the DEMO blocks of a function or class member. |
check_texi_docs
|
Check the texinfo help texts of a tree, writing nothing. |
classdef_texi2cache
|
Write a class and its documented members into this directory's doc-cache. |
classdef_texi2html
|
Generate HTML page for a class definition. |
find_DEMOS
|
Retrieve the DEMO code blocks from a particular function. |
find_GHurls
|
Retrieve unique URLs to every function's location within the package's GitHub repository. |
folder_texi2cache
|
Rebuild the doc-cache of the current directory. |
function_texi2cache
|
Write one function's entry into this directory's doc-cache. |
function_texi2html
|
Generate HTML page for a particular function. |
list_packages
|
List pkg-installable packages from Octave Packages. |
package_texi2cache
|
Regenerate the ‘doc-cache’ files of a package from its source tree. |
package_texi2html
|
Generate HTML pages for an entire package. |
package_texi2qch
|
Generate a Qt compressed help file for an entire package. |
pkg_doc_options
|
Settings for the documentation builders of a package. |