liz/easy-doc-bundle

Symfony application documentation generator

Installs: 25

Dependents: 0

Suggesters: 0

Stars: 0

Watchers: 1

Forks: 8

Language:HTML

Type:symfony-bundle

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

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:

EasyDoc in action

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