Short answer is:

  cd tools
  make doc

This probably won't work... Step by step, this gives:

 * download and install Cheetah. This is a templating language for
python. Pros: if you know python, you know (almost) Cheetah, no extra
language needed. http://www.cheetahtemplate.org/

 * download and install wikify.py. It's used to convert some of the
ascii content to html, according to GC wiki. Open jalapi.py, there's
an URL for it. (I did not want to include in the repos, because of
license which would have need a special notice. Anyway...). Download
and put in a directory you'll remember.


Then, to generate *one* html file:

# adjust PYTHONPATH
export PYTHONPATH=/path/to/remembered/dir
# inform where are the samples to auto generate link from lib to
samples
export SAMPLEDIR=../unvalidated/sample
# then...
python jalapi.py jalapi_html.tmpl file.jal > file.html


DON'T COMMIT YOUR file.html ! You need to set the mimetype as svn
property so GC's apache knows how to serve the file. Open
jalapi_generate.sh, see how it's automatically done when "make doc",
also search the group for "svn:mime-type" for more. Prefer use
jalapi_generate.sh script, even it generates all, you'll sure not to
forget something...


This is quite complicated, and I apologize for this, but these are
just dependencies issues (and maybe technical workaround too --
mimetype --, on wich we don't have any control...).

Let me know if you have any troubles.


Seb


On 8 oct, 09:05, Eur van Andel <[EMAIL PROTECTED]> wrote:
> On 3 Oct 2008, at 22:45 , [EMAIL PROTECTED] wrote:
>
> > Issue 15: HTML documentation generator
> >http://code.google.com/p/jallib/issues/detail?id=15
>
> can I run this script on my libs to see the results? If so, how?
>
> ---
> ir EE van Andel [EMAIL PROTECTED]  http://www.fiwihex.nl
> Fiwihex B.V. Wierdensestraat 74, NL7604BK Almelo, Netherlands
> tel+31-546-491106 fax+31-546-491107
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"jallib" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/jallib?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to