artur-gajewski / documentor-bundle
Symfony2 bundle to implement phpDocumentor into any project from which the documentation is accessible with a browser.
Installs: 11 049
Dependents: 0
Suggesters: 0
Security: 0
Stars: 7
Watchers: 1
Forks: 6
Open Issues: 2
Type:symfony-bundle
Requires
- php: >=5.3.3
This package is not auto-updated.
Last update: 2024-10-26 13:43:00 UTC
README
What is DocumentorBundle?
DocumentorBundle is a Symfony2 bundle that wraps phpDocumentor2 to generate your project's documentation.
Basic Usage
- Install and enable the bundle for your project's development environment
- Run
app/consoledocumentation:create
to generate the documentation for files located in./src
- Your project documentation is now available at
web/bundles/documentor
or http://yourproject.dev/app\_dev.php/bundles/documentor/index.html
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
DocumentorBundle requires the following:
- PHP 5.3.3 or higher
- phpDocumentor2
- phpDocumentor2 should be callable as
phpdoc
from the CLI
Installation
The suggested install method is via Composer
-
Add DocumentorBundle to your
composer.json
file:{ "require-dev": { "artur-gajewski/phpdocumentor-bundle": "dev-master" } }
-
Tell Composer to update this bundle:
php composer.phar update artur-gajewski/phpdocumentor-bundle
-
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?
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
Contact
- Twitter: @GajewskiArtur
- Github: https://github.com/artur-gajewski
- E-mail: info@arturgajewski.com
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!