PHPackages                             artur-gajewski/documentor-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. artur-gajewski/documentor-bundle

ActiveSymfony-bundle[Utility & Helpers](/categories/utility)

artur-gajewski/documentor-bundle
================================

Symfony2 bundle to implement phpDocumentor into any project from which the documentation is accessible with a browser.

711.1k↑57.9%5[1 PRs](https://github.com/artur-gajewski/DocumentorBundle/pulls)PHP

Since Sep 17Pushed 12y agoCompare

[ Source](https://github.com/artur-gajewski/DocumentorBundle)[ Packagist](https://packagist.org/packages/artur-gajewski/documentor-bundle)[ RSS](/packages/artur-gajewski-documentor-bundle/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

README
======

[](#readme)

What is DocumentorBundle?
-------------------------

[](#what-is-documentorbundle)

DocumentorBundle is a Symfony2 bundle that wraps [phpDocumentor2](https://github.com/phpDocumentor/phpDocumentor2) to generate your project's documentation.

Basic Usage
-----------

[](#basic-usage)

1. Install and enable the bundle for your project's development environment
2. Run `app/consoledocumentation:create` to generate the documentation for files located in `./src`
3. Your project documentation is now available at `web/bundles/documentor` or [http://yourproject.dev/app\\\_dev.php/bundles/documentor/index.html](http://yourproject.dev/app%5C_dev.php/bundles/documentor/index.html)

Features
--------

[](#features)

DocumentorBundle boasts the following features:

- Generates documentation with a simple console command.
- No need to enter source and target paths.
- Configurable to make sure it only works in your development environment.

Requirements
------------

[](#requirements)

DocumentorBundle requires the following:

- PHP 5.3.3 or higher
- [phpDocumentor2](https://github.com/phpDocumentor/phpDocumentor2)
- phpDocumentor2 should be callable as `phpdoc` from the CLI

Installation
------------

[](#installation)

The suggested install method is via [Composer](http://getcomposer.org)

1. Add DocumentorBundle to your `composer.json` file:

    ```
    {
        "require-dev": {
            "artur-gajewski/phpdocumentor-bundle": "dev-master"
        }
    }
    ```
2. Tell Composer to update this bundle:

    ```
    php composer.phar update artur-gajewski/phpdocumentor-bundle
    ```
3. Enable the bundle for your development environment:

    ```
    // app/AppKernel.php

        public function registerBundles()
        {
            // Register normal bundles

            if (in_array($this->getEnvironment(), array('dev', 'test'))) {
                // ...
                $bundles[] = new Aga\DocumentorBundle\DocumentorBundle();
            }
        }
    ```

How to use DocumentorBundle?
----------------------------

[](#how-to-use-documentorbundle)

Go to your project root and generate the documentation using the bundle's built-in DocumentorCommand:

```
$ app/console documentation:create
```

This command will generate documentation for all files in the `src/` directory.

After generating the documentation, the command executes `app/console assets:install` to copy the newly generated documentation to `web/bundles/documentor`, where you can access it from disk or via your project's website at [http://yourproject.dev/app\_dev.php/bundles/documentor/index.html](http://yourproject.dev/app_dev.php/bundles/documentor/index.html)

Contact
-------

[](#contact)

- Twitter: [@GajewskiArtur](http://twitter.com/GajewskiArtur)
- Github:
- E-mail:

Want to contribute?
-------------------

[](#want-to-contribute)

If you want to contribute to this project then just fork it, modify it and send a pull request. It's dead simple!

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity31

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 57.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/3ba89395df6a300cbd336d7b0fd2de2cb18e5c06a74a103d5487dff6ff727e8c?d=identicon)[artur-gajewski](/maintainers/artur-gajewski)

---

Top Contributors

[![johnkary](https://avatars.githubusercontent.com/u/135607?v=4)](https://github.com/johnkary "johnkary (4 commits)")[![lineke](https://avatars.githubusercontent.com/u/1242047?v=4)](https://github.com/lineke "lineke (2 commits)")[![philwc](https://avatars.githubusercontent.com/u/617110?v=4)](https://github.com/philwc "philwc (1 commits)")

### Embed Badge

![Health badge](/badges/artur-gajewski-documentor-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/artur-gajewski-documentor-bundle/health.svg)](https://phpackages.com/packages/artur-gajewski-documentor-bundle)
```

###  Alternatives

[lullabot/amp

A set of useful classes and utilities to convert html to AMP html (See https://www.ampproject.org/)

3802.9M10](/packages/lullabot-amp)[pragmarx/coollection

Laravel Illuminate collection with objectified properties

943.4M11](/packages/pragmarx-coollection)[valorin/random

Random is a simple helper package designed to make it easy to generate a range of different cryptographically secure random values.

228188.4k2](/packages/valorin-random)[pragmarx/ia-str

Laravel Illuminate Agnostic Str

523.5M5](/packages/pragmarx-ia-str)[sailenicolas/forceutf8

PHP Class Encoding featuring popular Encoding::toUTF8() function --formerly known as forceUTF8()-- that fixes mixed encoded strings.

53267.9k](/packages/sailenicolas-forceutf8)[prism-php/bedrock

A provider for Prism adding support for AWS Bedrock.

35116.8k1](/packages/prism-php-bedrock)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)