https://github.com/cakephp/cakephp-api-docs
CakePHP API Docs
https://github.com/cakephp/cakephp-api-docs
Last synced: 3 months ago
JSON representation
CakePHP API Docs
- Host: GitHub
- URL: https://github.com/cakephp/cakephp-api-docs
- Owner: cakephp
- License: mit
- Created: 2013-02-19T02:39:45.000Z (almost 13 years ago)
- Default Branch: 2.x
- Last Pushed: 2025-10-23T13:29:42.000Z (3 months ago)
- Last Synced: 2025-10-23T15:25:27.160Z (3 months ago)
- Language: PHP
- Homepage: http://api.cakephp.org
- Size: 5.08 MB
- Stars: 28
- Watchers: 23
- Forks: 16
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CakePHP API docs #
The CakePHP API docs allow you to build the API documentation as seen on
https://api.cakephp.org
### Running documentation generator on a CakePHP codebase
The tool generates documentation from CakePHP source code. According to the Makefile, you need:
- A local clone of the CakePHP repository (default location: ../cakephp/)
- Run the generator command
For example, to test with CakePHP 5.2:
#### Ensure you have a CakePHP clone
```
cd ../cakephp/ && git checkout origin/5.x && cd -
```
#### Run the generator
```
php bin/apitool.php generate --config cakephp5 --version 5.2 --tag origin/5.x --output-dir build/test/ ../cakephp
```