easycorp/easy-doc-bundle

Symfony application documentation generator

v1.1.1 2017-01-27 07:32 UTC

Requires

• php: >=5.3.3
• symfony/dependency-injection: ~2.3|~3.0
• symfony/framework-bundle: ~2.3|~3.0
• symfony/twig-bridge: ^2.3.4|~3.0
• symfony/twig-bundle: ~2.3|~3.0
• twig/extensions: ~1.0
• twig/twig: ~1.14,>=1.14.2|~2.0

MIT

• Javier Eguiluz

• generator
• documentation
• project

README

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 easycorp/easy-doc-bundle

Step 2: Enable the Bundle

// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        // ...

        if (in_array($this->getEnvironment(), ['dev', 'test'])) {
            // ...

            if ('dev' === $this->getEnvironment()) {
                // ...
                $bundles[] = new EasyCorp\Bundle\EasyDocBundle\EasyDocBundle();
            }
        }
    }

    // ...
}

Usage

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

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