{"id":17343455,"url":"https://github.com/firesphere/silverstripe-docgenerator","last_synced_at":"2025-04-14T20:10:59.488Z","repository":{"id":62504943,"uuid":"56299815","full_name":"Firesphere/silverstripe-docgenerator","owner":"Firesphere","description":"Generate APIGen documentation on dev/build","archived":false,"fork":false,"pushed_at":"2019-06-03T04:49:04.000Z","size":14,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T08:23:13.694Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Firesphere.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-15T07:20:10.000Z","updated_at":"2020-10-03T23:03:38.000Z","dependencies_parsed_at":"2022-11-02T10:16:02.722Z","dependency_job_id":null,"html_url":"https://github.com/Firesphere/silverstripe-docgenerator","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Firesphere%2Fsilverstripe-docgenerator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Firesphere%2Fsilverstripe-docgenerator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Firesphere%2Fsilverstripe-docgenerator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Firesphere%2Fsilverstripe-docgenerator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Firesphere","download_url":"https://codeload.github.com/Firesphere/silverstripe-docgenerator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248952350,"owners_count":21188426,"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":["hacktoberfest"],"created_at":"2024-10-15T16:09:27.281Z","updated_at":"2025-04-14T20:10:59.471Z","avatar_url":"https://github.com/Firesphere.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docblock Generator\n[![Scrutinizer](https://img.shields.io/scrutinizer/g/axyr/silverstripe-ideannotator.svg)](https://scrutinizer-ci.com/g/CasaLaguna/silverstripe-docgenerator/badges/quality-score.png?b=master)\n![CodeClimate](https://codeclimate.com/github/Firesphere/silverstripe-docgenerator/badges/gpa.svg)\n![Travis](https://travis-ci.org/Firesphere/silverstripe-docgenerator.svg)\n\nThis tiny wrapper on APIGen will generate documentation from your PHP Docblocks annotations. There's really nothing more to it.\n\n# Usage\n\nAdd the wished module, and it's target directory in your config.yml like this:\n```YML\nDocGenerator:\n  enabled: false\n  document_modules:\n    modulename: \"Target/Directory/Relative/to/DocRoot\"\n```\n\nAdviced is to only enable it in dev, like this:\n```YML\nOnly:\n  environment: 'dev'\n---\nDocGenerator:\n  enabled: true\n  document_modules:\n    docgenerator: \"docgenerator/docs/en/apidocs\"\n```\nDocumentation build by APIGen will be build in the target directory specific for each module.\n\nAlso, you can generate single API docs for multiple directories/modules at once:\n```YML\n---\nOnly:\n  environment: 'dev'\n---\nDocGenerator:\n  enabled: true # doc generator control switch\n  multi_module_enabled: true # multi module doc generator control switch\n  multi_module_destination: \"apidocs\" # documentation generator target directory\n  multi_modules:\n    - mysite\n    - framework\n    - mymodule\n    - myothermodule\n    - ...\n```\nDocumentation build by APIGen `multi_module_enabled: true` will be stored in single directory.\n\n## Did you read this entire readme? You rock!\n\nPictured below is a cow, just for you.\n```\n\n               /( ,,,,, )\\\n              _\\,;;;;;;;,/_\n           .-\"; ;;;;;;;;; ;\"-.\n           '.__/`_ / \\ _`\\__.'\n              | (')| |(') |\n              | .--' '--. |\n              |/ o     o \\|\n              |           |\n             / \\ _..=.._ / \\\n            /:. '._____.'   \\\n           ;::'    / \\      .;\n           |     _|_ _|_   ::|\n         .-|     '==o=='    '|-.\n        /  |  . /       \\    |  \\\n        |  | ::|         |   | .|\n        |  (  ')         (.  )::|\n        |: |   |;  U U  ;|:: | `|\n        |' |   | \\ U U / |'  |  |\n        ##V|   |_/`\"\"\"`\\_|   |V##\n           ##V##         ##V##\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffiresphere%2Fsilverstripe-docgenerator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffiresphere%2Fsilverstripe-docgenerator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffiresphere%2Fsilverstripe-docgenerator/lists"}