firesphere / silverstripe-docgenerator
Generate APIGen docs on flush
Installs: 42
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 2
Open Issues: 0
Type:silverstripe-module
Requires
- apigen/apigen: ^4.1
- silverstripe/framework: >=3.1.0
Requires (Dev)
- phpunit/phpunit: ~3.7@stable
This package is auto-updated.
Last update: 2024-10-29 04:31:08 UTC
README
This tiny wrapper on APIGen will generate documentation from your PHP Docblocks annotations. There's really nothing more to it.
Usage
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.
Did you read this entire readme? You rock!
Pictured below is a cow, just for you.
/( ,,,,, )\
_\,;;;;;;;,/_
.-"; ;;;;;;;;; ;"-.
'.__/`_ / \ _`\__.'
| (')| |(') |
| .--' '--. |
|/ o o \|
| |
/ \ _..=.._ / \
/:. '._____.' \
;::' / \ .;
| _|_ _|_ ::|
.-| '==o==' '|-.
/ | . / \ | \
| | ::| | | .|
| ( ') (. )::|
|: | |; U U ;|:: | `|
|' | | \ U U / |' | |
##V| |_/`"""`\_| |V##
##V## ##V##