https://github.com/firesphere/silverstripe-docgenerator
Generate APIGen documentation on dev/build
https://github.com/firesphere/silverstripe-docgenerator
hacktoberfest
Last synced: over 1 year ago
JSON representation
Generate APIGen documentation on dev/build
- Host: GitHub
- URL: https://github.com/firesphere/silverstripe-docgenerator
- Owner: Firesphere
- License: bsd-3-clause
- Created: 2016-04-15T07:20:10.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-06-03T04:49:04.000Z (about 7 years ago)
- Last Synced: 2025-03-28T08:23:13.694Z (over 1 year ago)
- Topics: hacktoberfest
- Language: PHP
- Size: 13.7 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Docblock Generator
[](https://scrutinizer-ci.com/g/CasaLaguna/silverstripe-docgenerator/badges/quality-score.png?b=master)
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:
```YML
DocGenerator:
enabled: false
document_modules:
modulename: "Target/Directory/Relative/to/DocRoot"
```
Adviced is to only enable it in dev, like this:
```YML
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:
```YML
---
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##
```