https://github.com/easycorp/easy-doc-bundle

Symfony application documentation generator
https://github.com/easycorp/easy-doc-bundle

bundle documentation generator php symfony symfony-bundle

Last synced: about 4 hours ago
JSON representation

Symfony application documentation generator

• Host: GitHub
• URL: https://github.com/easycorp/easy-doc-bundle
• Owner: EasyCorp
• License: mit
• Created: 2017-01-24T07:20:49.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-04-02T19:34:01.000Z (almost 6 years ago)
• Last Synced: 2025-02-01T18:17:39.091Z (about 18 hours ago)
• Topics: bundle, documentation, generator, php, symfony, symfony-bundle
• Language: HTML
• Homepage: https://easycorp.io/EasyDoc
• Size: 349 KB
• Stars: 102
• Watchers: 16
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
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](/src/Resources/doc/images/easydoc-index.png)

Installation

------------

### Step 1: Download the Bundle

```bash

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

```

### Step 2: Enable the Bundle

```php

// 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:

```bash

$ cd your-project/

$ ./bin/console doc

```