{"id":23425437,"url":"https://github.com/tamdaz/doc2html","last_synced_at":"2026-01-07T09:44:16.191Z","repository":{"id":248858540,"uuid":"827879105","full_name":"tamdaz/doc2html","owner":"tamdaz","description":"A PHP library that enables to convert PHP docs in HTML files.","archived":false,"fork":false,"pushed_at":"2024-08-02T16:41:45.000Z","size":71,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-05T03:25:42.905Z","etag":null,"topics":["doc2html","docgen","docgenerator","phpdoc","phpdocumentor"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tamdaz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-12T15:20:08.000Z","updated_at":"2024-10-31T04:57:05.000Z","dependencies_parsed_at":"2024-07-17T14:36:01.235Z","dependency_job_id":"63cba371-38a6-426f-8f8e-bc738a904cdb","html_url":"https://github.com/tamdaz/doc2html","commit_stats":null,"previous_names":["tamdaz/doc2html"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamdaz%2Fdoc2html","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamdaz%2Fdoc2html/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamdaz%2Fdoc2html/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamdaz%2Fdoc2html/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tamdaz","download_url":"https://codeload.github.com/tamdaz/doc2html/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246263808,"owners_count":20749352,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["doc2html","docgen","docgenerator","phpdoc","phpdocumentor"],"created_at":"2024-12-23T05:12:43.008Z","updated_at":"2026-01-07T09:44:16.152Z","avatar_url":"https://github.com/tamdaz.png","language":"PHP","readme":"\u003e [!WARNING]\n\u003e For the moment, this project is in the development phase. It is not yet completely finished.\n\n# doc2html\n\n![Packagist License](https://img.shields.io/packagist/l/tamdaz/doc2html)\n![Packagist Version](https://img.shields.io/packagist/v/tamdaz/doc2html)\n\ndoc2html is a tool that enables to convert PHP documentation in HTML files.\nThis tool can be used for any PHP project (namely Symfony, Laravel, Slim, CakePHP...)\n\n![cover image](https://repository-images.githubusercontent.com/827879105/e2822103-440c-4fd3-ab1a-cc117473c3b4)\n\n## Installation\n```shell\ncomposer require --dev tamdaz/doc2html\n```\n\n## Configuration\n\nTo generate a configuration, execute:\n```shell\n./vendor/bin/doc2html gen-config\n```\n\n```php\nreturn [\n    // Path where the documentation will be saved.\n    'output_dir' =\u003e __DIR__ . '/output',\n\n    // For each action, indicate it to standard output (STDOUT).\n    'verbose' =\u003e true,\n\n    // When these namespaces are excluded, they will not be taken into account by the\n    // tool (except when exceptions apply to the \"include_classes\" parameter).\n    'exclude_namespaces' =\u003e [\n        // ...\n    ],\n\n    // When these namespaces are included, they will be taken into account by the\n    // tool (except when exceptions apply to the \"exclude_classes\" parameter).\n    'include_namespaces' =\u003e [\n        // ...\n    ],\n\n    // Exclude classes to avoid generate documentation, even though in the included namespace.\n    'exclude_classes' =\u003e [\n        // ...\n    ],\n\n    // Classes to include to generate documentation.\n    // INFO: If the specified class is in the excluded namespace, it will still be taken\n    // into account in the classmap.\n    'include_classes' =\u003e [\n        // ...\n    ],\n];\n```\n\nBefore generating the documentation, it is necessary to target the different directories because\nit allows to register your classes in the classmap.\n\n```json\n\"autoload\": {\n    \"classmap\": [\n        \"examples/\", \"src/\"\n    ]\n},\n```\n\n```shell\ncomposer dump-autoload\n```\n\nFor information, this library uses the classmap of Composer to allow you\nto choose those you do not want to generate documentation.\n\nAfter that, you can generate it by executing:\n```shell\n./vendor/bin/doc2html generate-doc\n```\n\n\u003e [!TIP]\n\u003e You can create an alias for this command and save it in `~/.bashrc` file.\n\n```shell\nexport doc2html=\"./vendor/bin/doc2html\"\n```\n\n## Contributors\nAny contributions are welcome.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftamdaz%2Fdoc2html","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftamdaz%2Fdoc2html","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftamdaz%2Fdoc2html/lists"}