Skip to content
Symfony application documentation generator
Branch: master
Clone or download
javiereguiluz feature #15 Redesigned the "Licenses" panel (javiereguiluz)
This PR was merged into the master branch.

Discussion
----------

Redesigned the "Licenses" panel

This new design matches the compact design introduced recently for the "Routes" panel. The rest of panels will be updated soon.

### Listing

![licenses-list](https://cloud.githubusercontent.com/assets/73419/22481120/4f674d14-e7f4-11e6-9437-6ce65229cabf.png)

### Detail

Visible when you click on any row:

![licenses-detail](https://cloud.githubusercontent.com/assets/73419/22481122/52e06520-e7f4-11e6-8a59-4e7f856eb6fa.png)

Commits
-------

ecf10d3 Redesigned the "Licenses" panel
Latest commit 43748e9 Feb 1, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
LICENSE.md
README.md
composer.json

README.md

EasyDoc

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 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
You can’t perform that action at this time.