CakePHP API Docs
JavaScript HTML CSS Makefile Other
Switch branches/tags
Nothing to show
Latest commit 6577fd4 Apr 30, 2017 @markstory markstory committed on GitHub Merge pull request #87 from tenkoma/cannot-jump-from-submenu
Enable anchor of submenu and megamenu.
Permalink
Failed to load latest commit information.
templates/cakephp Enable anchor of submenu and megamenu. Apr 30, 2017
.dockerignore
.gitattributes Renamed libs to vendor Oct 3, 2012
.gitignore Upgrade to new apigen. I think.. Jul 12, 2016
.gitmodules Remove old ApiGen version. Jul 12, 2016
Dockerfile Attempt to fix API builds. Dec 29, 2016
LICENSE.md Year bump Jan 8, 2012
Makefile Fix build by ignore errors. Mar 14, 2017
README.md add build version 2.9, 3.3, 3.4 to README Feb 8, 2017
apigen.neon Remove download button Mar 16, 2017
composer.json Require a different version of ApiGen Nov 20, 2016
jenkins.groovy Poll repo instead of using hooks. Nov 17, 2016
nginx.conf improve redirect (Minimize number of redirects, Do not cache redirect… Mar 9, 2017

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
  • 3.0
  • 3.1
  • 3.2
  • 3.3
  • 3.4

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.