Skip to content
YUI Javascript Documentation Tool
HTML JavaScript CSS
Pull request Compare This branch is 909 commits behind master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin Fixed Merge Conflict
ext Updated setuptools, removed TODO, fixed errors created by high bit ch…
template add -N / --nocode to the command options, which means without source …
test Removed the simplejson requirement when native support is available
.gitignore highlight handles high bit characters better. [fixes #22]
CHANGES Added known issues and workarounds. Identified international characte…
INSTALL
KNOWN_ISSUES Completely refactored all io operations to eliminate anything encodin…
README Last commit to python version
TAGS doc update
license.txt 2009 -> 2010

README

This code line is out of date and no longer supported. ^davglass 05.09.2012





yuidoc README

yuidoc is a set of tools to generate the API documentation for the JavaScript
in the YUI library.  The docs are derived completely from JavaDoc style
comment blocks; no attempt is made to understand the javascript itself.

yuidoc requires Python 2.3+ with the following extensions:
    simplejson - for reading and writing json (required for Python versions below 2.6.0)
    cheetah    - for generating the html docs
    pygments   - for colorizing the source

The code for yuidoc is provided under a BSD license:
    http://developer.yahoo.net/yui/license.html

Project home page:
    http://developer.yahoo.com/yui/yuidoc/
    
Source code:
    http://github.com/yui/yuidoc

Issue tracker:
    http://yuilibrary.com/projects/yuidoc

    
Files:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

README
    This file

CHANGES
    The change log

INSTALL
    Installation instructions

KNOWN_ISSUES
    Known issues and workarounds.

TAGS
    Supported tags

license.txt
    Open source license details.

bin/yuidoc_parse.py
    The comment block parser.  Parses all javascript files in the the specified 
    directories and outputs a single file containing a json structure of the 
    parsed documentation.

bin/yuidoc_highlight.py
    Colorizes the script source

bin/yuidoc_generate.py
    Reads the json output from parser.py and generates HTML docs.

bin/yuidoc.py
    Wrapper for yuidoc_parse, yuidoc_highlight, and yuidoc_generate

bin/example.sh 
    An example shell script to run both the parser and generator on a src tree

bin/example.bat
    An example batch for for DOS/Windows

ext
    External required packages, provided for convenience


Something went wrong with that request. Please try again.