README

This package provides automatic generation of documentation for your app schedule

Installation

Run commands:

composer require artarts36/laravel-schedule-documentator

php artisan vendor:publish --provider="ArtARTs36\LaravelScheduleDocumentator\Providers\LaravelScheduleDocumentatorProvider" --tag=config

Simple generation:

$generator = app(\ArtARTs36\LaravelScheduleDocumentator\Services\DocGenerateHandler::class);

$generator->handle('md', '/path/to/file.md');
$generator->handle('json', '/path/to/file.json');
$generator->handle('csv', '/path/to/file.csv');

Console Commands

Command	Description
artisan schedule:doc {format} {path}	Generate documentation

Available Formats

Format	Documentator Class
Json	ArtARTs36\LaravelScheduleDocumentator\Documentators\JsonDocumentator
Csv	ArtARTs36\LaravelScheduleDocumentator\Documentators\CsvDocumentator
Md	ArtARTs36\LaravelScheduleDocumentator\Documentators\MarkdownDocumentator

Installation:

Run: composer require artarts36/laravel-schedule-documentator
Add LaravelScheduleDocumentatorProvider into providers
Run: 'php artisan vendor:publish --tag=schedule_doc'

Add Custom Format

Create new Documentator (by contract \ArtARTs36\LaravelScheduleDocumentator\Contracts\Documentator)
Add entry "extension/documentator" into config/schedule_doc.php in field "ext_documentator"

    [
        'ext_documentator' => [
            // other documentators
            'zip' => MyZipDocumentator::class,
        ],
    ]

Command Description

Must fill property description in console commands for full documentation.

Use the PHP CS Fixer rule PhpCsFixerGoodFixers/laravel_command_no_empty_description to prevent undescribed commands from entering your repository.

artarts36 / laravel-schedule-documentator

Maintainers

Details