CakePHP API docs
The CakePHP API docs allow you to build the API documentation as seen on api.cakephp.org. These API docs are built with apigen. Thanks to the Apigen team for producing a great tool.
- PHP 5.3.7 or greater.
- A clone of CakePHP
After cloning the repository make sure you install the git submodules:
git submodule init git submodule update
After installing the submodules, you'll need to have a clone of cakephp/cakephp as well. Bulding the docs uses the CakePHP source code, and will modify which tag/reference is currently checked out.
Building the documentation
To build the documentation you will need to use
make. You can build all the
Or you can build one version by using:
Where the trailing version number is the major.minor release to build. The following versions can be built:
By default the api-docs assume that
../cakephp is a git clone of CakePHP.
Also documentation will be output to
./build/api. If you want to change
these directories you can use the
make build-2.0 SOURCE_DIR=../cake BUILD_DIR=../api-output
Is an example of using custom directories.