public
Description: YUI Javascript Documentation Tool
Homepage: http://yuilibrary.com/projects/yuidoc
Clone URL: git://github.com/yui/yuidoc.git
commit  9e4e1282f74dd03919fb97984d54beddd7945fdb
tree    5beaedb4903ed6f86e9d4333ae22bb06d67e47c1
parent  005f9992449cd5676e4c9f36eb57532a89e3f4bf
yuidoc / INSTALL
100644 75 lines (48 sloc) 2.444 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
**********************************************************************
NOTE: 2009-10-27 -- there have been reports of easy_install trying
to pull Cheetah 2.4.0 and failing. If this occurs, download and
install version 2.2.2 (which is the current stable version):
 
http://pypi.python.org/packages/source/C/Cheetah/Cheetah-2.2.2.tar.gz#md5=e0d89113ab6bb0935d2b67395960264c
**********************************************************************
 
One-time setup for python:
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Unix (including cygwin):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
1. Check to see if setuptools is installed.
    Execute this command:
        which easy_install
    
    If it returns something, it's installed skip to step #3.
 
 
2. Install Setup Tools:
    Extract the archive in ext and install the package
    sudo python setup.py install (no sudo needed for cygwin or windows)
 
    setuptools
        cd ext
        tar xfvz setuptools-0.6c9.tar.gz
        cd setuptools-0.6c9
        sudo python setup.py install
 
3. Install the dependencies
 
    easy_install pygments
    easy_install Cheetah
    easy_install simplejson
 
 
4. Make a copy of yuidoc/bin/example.sh and modify the paths to suit your needs.
 
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
DOS/Windows:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
1. Install Python
 
  * Use Python 2.4.3 as 2.5 generates warnings because the json parser has
    not been updated yet:
 
        http://www.python.org/ftp/python/2.4.3/python-2.4.3.msi
 
  * Extract each of the archives with WinZIP and install as described in
    the unix section.
 
  * Copy _namemapper.pyd to C:\Python24\Lib\site-packages\Cheetah
 
 
2,3. Same as above
 
4. Add C:\python24 to your PATH
 
5. Copy yuidoc\bin\example.bat and modify the paths to suit your needs
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
See TAGS for a brief description of the supported tags. Checking out the
source for the YUI library is a good way to get to know how it works. Ex:
http://developer.yahoo.com/yui/docs/Event.js.html
 
NOTE: This tool will generally work with code that has been commented for
jsdoc, with one exception: you must have at least one @module block defined
somewhere in your source. If you don't, the program will run but won't
generate anything.