Adding phpDocumentor and ./scripts/docs

recurly · Apr 8, 2020 · c89ab60 · c89ab60
1 parent d31272a
commit c89ab60
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,7 @@ composer.lock
 # PHPUnit
 .phpunit.result.cache
 /coverage/
+
+# phpDocumenter
+.phpdoc
+/docs/
diff --git 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
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+rm -rf ./docs
+
+./vendor/bin/phpdoc -d ./lib/recurly -t ./docs/ --title "Recurly v3 API"