CakePHP API Docs
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
templates/cakephp
.dockerignore
.gitattributes
.gitignore
.gitmodules
Dockerfile
LICENSE.md
Makefile
README.md
apigen.neon
composer.json
composer.lock
jenkins.groovy
nginx.conf

README.md

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.

Requirements:

  • PHP 5.5 or greater.
  • Make
  • A clone of CakePHP
  • git

Building the documentation

To build the documentation you will need to use make. You can build all the documentation using:

make build-all

Or you can build one version by using:

make build-2.0

Where the trailing version number is the major.minor release to build. The following versions can be built:

  • 1.2
  • 1.3
  • 2.0
  • 2.1
  • 2.2
  • 2.3
  • 2.4
  • 2.5
  • 2.6
  • 2.7
  • 2.8
  • 2.9
  • 2.10
  • 3.0
  • 3.1
  • 3.2
  • 3.3
  • 3.4
  • 3.5

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 SOURCE_DIR and BUILD_DIR directories:

make build-2.0 SOURCE_DIR=../cake BUILD_DIR=../api-output

Is an example of using custom directories.