A phpdoc responsive template for hubzero-cms api
This is a responsive template for phpdoc to generate doc for hubzero.
-
In the hubzero-cms,
$ composer require --dev phpdocumentor/phpdocumentor
-
Copy this template into the phpDocumentor
$ cp -p ./ <address_of_hubzero-cms>/core/vendor/phpdocumentor/phpdocumentor/data/templates/responsive
-
Go to the
hubzero-cms/core
directory$ cd <address_of_hubzero-cms/core>
-
Run phpDocumentor directly from your
vendor
directory in thecore
directory$ ./vendor/phpdocumentor/phpdocumentor/bin/phpdoc -d ./components -d ./plugins -d ./templates -d ./vendor/hubzero/framework/src -t <address_of_doc> --title "Hubzero Api Documentation" --template="responsive"
-
It will generates a directory for all the stuff in the hubzero/framework and hubzero-cms/core into the
<address_of_doc>