help-octave
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Generating package HTML for Octave Forge


From: Daniel Kraft
Subject: Generating package HTML for Octave Forge
Date: Thu, 5 Jun 2014 12:58:49 +0200
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:24.0) Gecko/20100101 Thunderbird/24.5.0

Hi!

I want to release a first version of my new "level-set" package soon.
The functionality I want to include in this first version is finished,
and now I'm working on polishing the documentation.

In particular, I'm trying to generate the package HTML required for
release on Octave Forge.  For this, I'm using the "generate_html"
package, and the command

  generate_package_html ("level-set", "/tmp", "octave-forge")

Basically, it works fine, and my package and the resulting HTML can be
found at [1] and [2] (viewable HTML at [3]).

  [1] http://extra.domob.eu/level-set-0.1.tar.gz
  [2] http://extra.domob.eu/level-set-doc.tar.bz2
  [3] http://extra.domob.eu/level-set/

Does this look fine, or should I be doing something different?

I have two issues with the resulting HTML, though:

1) For functions with multiple signatures (for instance,
ls_solve_stationary [4]), the HTML looks very odd (with the second
signature intended).  It looks fine in Octave's help.  Is this expected
behaviour of generate_html, or is my Texinfo syntax wrong to produce
this kind of output?

  [4] http://extra.domob.eu/level-set/function/ls_solve_stationary.html

2) A lot of functions have demos, but with *none* of them the resulting
HTML includes a correct picture.  Is this a problem with my installation
of generate_html, or a bug in it?  It happens even if I add a trivial
demo like

  x = linspace (-pi, pi, 100);
  plot (x, sin (x));

While it would be nice to see some of the figures directly in the HTML,
I understand that some demos may be too complicated.  Is it possible to
disable inclusion of demos completely in the HTML?  Or maybe just
exclude some of them and fix the others, in case it is a problem with my
code?

Thank you very much!  I'm looking forward to releasing the package! :)

Yours,
Daniel

-- 
http://www.domob.eu/
OpenPGP: 901C 5216 0537 1D2A F071  5A0E 4D94 6EED 04F7 CF52
Namecoin: id/domob -> https://nameid.org/?name=domob
--
Done:  Arc-Bar-Cav-Hea-Kni-Ran-Rog-Sam-Tou-Val-Wiz
To go: Mon-Pri


Attachment: smime.p7s
Description: S/MIME Cryptographic Signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]