Setup documentation workflow (#72)

doctrine · Oct 7, 2024 · f355273 · f355273
1 parent 7cb7e8b
commit f355273
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 0 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,20 @@
+name: "Documentation"
+
+on:
+  pull_request:
+    branches:
+      - "*.x"
+    paths:
+      - ".github/workflows/documentation.yml"
+      - "docs/**"
+  push:
+    branches:
+      - "*.x"
+    paths:
+      - ".github/workflows/documentation.yml"
+      - "docs/**"
+
+jobs:
+  documentation:
+    name: "Documentation"
+    uses: "doctrine/.github/.github/workflows/[email protected]"
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,6 @@
 /phpcs.xml
 /.phpcs-cache
 /.phpunit.cache
+
+# phpDocumentor/guides output directory
+/output
diff --git a/composer.json b/composer.json
@@ -42,6 +42,7 @@
     },
     "require-dev": {
         "doctrine/coding-standard": "^12",
+        "phpdocumentor/guides-cli": "^1.4",
         "phpstan/phpstan": "^1.8.8",
         "phpunit/phpunit": "^10.5",
         "vimeo/psalm": "^5.24"

diff --git a/docs/en/sidebar.rst b/docs/en/sidebar.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. toctree::
     :depth: 3