sugared-rim/sami

Sami sweetened with ease

Maintainers

Details

github.com/sugared-rim/sami

Source

Issues

Installs: 13

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 2

Forks: 1

Open Issues: 0

0.5.0 2017-05-22 18:59 UTC

Requires

Requires (Dev)

MIT f1f71e2cd1dd6f6eb83998c2e6716349bff60770

  • Michael Mayer <michael.woop@schnittstabil.de>

phpdocsamisugaredpreconfiguredsugared-rim

This package is not auto-updated.

Last update: 2024-11-10 03:19:31 UTC

README

SensioLabsInsight

Sami sweetened with ease 🍒

SugaredRim\Sami takes an opinionated view of generating documentation with Sami, it is preconfigured to get you up and running as quickly as possible.

Install

$ composer require --dev sugared-rim/sami

Usage

Instead of creating a configuration file and running sami.phar update /path/to/config.php, just run sugared-rim-sami - that's it:

{
    ...
    "require-dev": {
        "sugared-rim/sami": ...
    },
    "scripts": {
        "doc": "sugared-rim-sami"
    }
}

Configuration

You may overwrite some options by putting it in your composer.json.

Some of the default settings:

{
    ...
    "scripts": {
        "doc": "sugared-rim-sami"
    },
    "extra": {
        "sugared-rim/sami": {
            "files": "src",
            "filter": "SugaredRim\\Sami\\ProtectedFilter",
            "build_dir": "build/sami",
            "cache_dir": "build/cache/sami"
        }
    }
}

All extra.sugared-rim/sami options are passed through the Sami constructor, except:

  • filter: A FQCN of the filter to use, sugared-rim-sami will create an instance for you.

License

MIT © Michael Mayer