• Stars
    star
    103
  • Rank 333,046 (Top 7 %)
  • Language
    HTML
  • License
    MIT License
  • Created almost 8 years ago
  • Updated over 5 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Symfony application documentation generator

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