liz/easy-doc-bundle

Symfony application documentation generator

v2.3 2019-02-26 07:09 UTC

Requires

• php: >=7.1
• phpdocumentor/reflection-docblock: >=4.0.0|~5.0
• symfony/dependency-injection: ^4.0
• symfony/framework-bundle: ^4.0
• symfony/twig-bridge: ^4.0
• symfony/twig-bundle: ^4.0
• twig/extensions: ^1.0
• twig/twig: ~1.14,>=1.14.2|~2.0

MIT

• Liz

• generator
• documentation
• project
• doc

README

Thanks easycorp/easy-doc-bundle This bundle generates the formal documentation for Symfony applications. This documentation is a HTML document that contains detailed information about every application element (routes, services, events, configuration, etc.)

When would this bundle be useful?

• As a reference to look for any application element details.
• As a document to get an overall idea of the application when adding new developers to the project.
• As a deliverable to the client who paid for the application development.
• As a searchable archive of legacy applications.

This is how it looks:

Installation

Step 1: Download the Bundle

$ composer require --dev liz/easy-doc-bundle

Step 2: Enable the Bundle

// app/bundles.php

// ...

return [
    // ...
    Liz\Bundle\EasyDocBundle\EasyDocBundle::class => ['dev'=>true, 'test'=>true],
    // ...
];

Usage

Run the doc command in your Symfony application to generate the documentation:

$ cd your-project/
$ ./bin/console doc