https://github.com/tamdaz/doc2html
A PHP library that enables to convert PHP docs in HTML files.
https://github.com/tamdaz/doc2html
doc2html docgen docgenerator phpdoc phpdocumentor
Last synced: 20 days ago
JSON representation
A PHP library that enables to convert PHP docs in HTML files.
- Host: GitHub
- URL: https://github.com/tamdaz/doc2html
- Owner: tamdaz
- License: mit
- Created: 2024-07-12T15:20:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-02T16:41:45.000Z (over 1 year ago)
- Last Synced: 2025-02-05T03:25:42.905Z (12 months ago)
- Topics: doc2html, docgen, docgenerator, phpdoc, phpdocumentor
- Language: PHP
- Homepage:
- Size: 69.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [!WARNING]
> For the moment, this project is in the development phase. It is not yet completely finished.
# doc2html
doc2html is a tool that enables to convert PHP documentation in HTML files.
This tool can be used for any PHP project (namely Symfony, Laravel, Slim, CakePHP...)
## Installation
```shell
composer require --dev tamdaz/doc2html
```
## Configuration
To generate a configuration, execute:
```shell
./vendor/bin/doc2html gen-config
```
```php
return [
// Path where the documentation will be saved.
'output_dir' => __DIR__ . '/output',
// For each action, indicate it to standard output (STDOUT).
'verbose' => true,
// When these namespaces are excluded, they will not be taken into account by the
// tool (except when exceptions apply to the "include_classes" parameter).
'exclude_namespaces' => [
// ...
],
// When these namespaces are included, they will be taken into account by the
// tool (except when exceptions apply to the "exclude_classes" parameter).
'include_namespaces' => [
// ...
],
// Exclude classes to avoid generate documentation, even though in the included namespace.
'exclude_classes' => [
// ...
],
// Classes to include to generate documentation.
// INFO: If the specified class is in the excluded namespace, it will still be taken
// into account in the classmap.
'include_classes' => [
// ...
],
];
```
Before generating the documentation, it is necessary to target the different directories because
it allows to register your classes in the classmap.
```json
"autoload": {
"classmap": [
"examples/", "src/"
]
},
```
```shell
composer dump-autoload
```
For information, this library uses the classmap of Composer to allow you
to choose those you do not want to generate documentation.
After that, you can generate it by executing:
```shell
./vendor/bin/doc2html generate-doc
```
> [!TIP]
> You can create an alias for this command and save it in `~/.bashrc` file.
```shell
export doc2html="./vendor/bin/doc2html"
```
## Contributors
Any contributions are welcome.