diff --git a/.gitignore b/.gitignore index 70579971..dd999fa3 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,7 @@ composer.lock # PHPUnit .phpunit.result.cache /coverage/ + +# phpDocumenter +.phpdoc +/docs/ \ No newline at end of file diff --git a/composer.json b/composer.json index 1c57742e..c0b40593 100644 --- a/composer.json +++ b/composer.json @@ -12,7 +12,10 @@ }, "require-dev": { "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0", + "doctrine/rst-parser": "dev-master", "phpcompatibility/php-compatibility": "^9.3", + "phpdocumentor/phpdocumentor": "dev-master", + "phpdocumentor/graphviz": "dev-master", "phpstan/phpstan": "^0.12.11", "phpunit/phpunit": "^8", "squizlabs/php_codesniffer": "^3.5" diff --git a/scripts/docs b/scripts/docs new file mode 100755 index 00000000..40ab98c4 --- /dev/null +++ b/scripts/docs @@ -0,0 +1,5 @@ +#!/usr/bin/env bash + +rm -rf ./docs + +./vendor/bin/phpdoc -d ./lib/recurly -t ./docs/ --title "Recurly v3 API"