Generate APIGen documentation on dev/build
BSD-3-CLAUSE License
This tiny wrapper on APIGen will generate documentation from your PHP Docblocks annotations. There's really nothing more to it.
Add the wished module, and it's target directory in your config.yml like this:
DocGenerator:
enabled: false
document_modules:
modulename: "Target/Directory/Relative/to/DocRoot"
Adviced is to only enable it in dev, like this:
Only:
environment: 'dev'
---
DocGenerator:
enabled: true
document_modules:
docgenerator: "docgenerator/docs/en/apidocs"
Documentation build by APIGen will be build in the target directory specific for each module.
Also, you can generate single API docs for multiple directories/modules at once:
---
Only:
environment: 'dev'
---
DocGenerator:
enabled: true # doc generator control switch
multi_module_enabled: true # multi module doc generator control switch
multi_module_destination: "apidocs" # documentation generator target directory
multi_modules:
- mysite
- framework
- mymodule
- myothermodule
- ...
Documentation build by APIGen multi_module_enabled: true
will be stored in single directory.
Pictured below is a cow, just for you.
/( ,,,,, )\
_\,;;;;;;;,/_
.-"; ;;;;;;;;; ;"-.
'.__/`_ / \ _`\__.'
| (')| |(') |
| .--' '--. |
|/ o o \|
| |
/ \ _..=.._ / \
/:. '._____.' \
;::' / \ .;
| _|_ _|_ ::|
.-| '==o==' '|-.
/ | . / \ | \
| | ::| | | .|
| ( ') (. )::|
|: | |; U U ;|:: | `|
|' | | \ U U / |' | |
##V| |_/`"""`\_| |V##
##V## ##V##