firesphere/silverstripe-docgenerator

Generate APIGen docs on flush

Installs: 37

Dependents: 0

Suggesters: 0

Stars: 3

Watchers: 1

Forks: 2

Open Issues: 1

Type:silverstripe-module

0.0.2 2016-04-17 05:07 UTC

README

Scrutinizer CodeClimate Travis

This tiny wrapper on APIGen, wil generate documentation from your PHP Docblocks. 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.

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##