mrdoob/three.js — pull request #838 by jterrace (2011-12-02 19:57:32+00:00)
Title: Adds documentation using sphinx - take 2

This adds a top-level directory called ``doc``.

To build the documentation, [sphinx](http://sphinx.pocoo.org/) must be installed. From the doc directory, just run ``make html`` (mac/linux) or ``make.bat html`` (windows) and a directory ``doc/_build/html`` is created with the output. Other output formats can also be used, such as ``latexpdf`` to build the documentation in PDF format.

I have added stubs for all classes in ``src/cameras``, ``src/core`` and ``src/lights``, and I fully documented ``THREE.Color`` as an example of what the docs can look like. Hopefully others can help continue to document the rest of the API.

Here is what the current documentation looks like:
http://www.cs.princeton.edu/~jterrace/temp/threejs/

Here is the fully documented Color class:
http://www.cs.princeton.edu/~jterrace/temp/threejs/api/core/Color.html

Other things can be added to the documentation, like the changelog:
http://www.cs.princeton.edu/~jterrace/temp/threejs/changelog.html

There is also an index of all pages and classes:
http://www.cs.princeton.edu/~jterrace/temp/threejs/genindex.html

You can also search for things:
http://www.cs.princeton.edu/~jterrace/temp/threejs/search.html?q=clone

It will be a lot of work to continue documenting the rest of the library, but hopefully by merging it now, others can help. I still think auto-generating the API documentation from the source itself would be much easier, but that was rejected.