From be3b5f1141ac5c1b8d904e897429149cf4be7713 Mon Sep 17 00:00:00 2001
From: Sebastian Meyer <sebastian@informathekar.de>
Date: Tue, 23 Jan 2024 17:59:30 +0100
Subject: [PATCH] Add phpDocumentor tooling

---
 .gitignore                      |  2 ++
 .phpdoc/guide/index.rst         |  0
 .phpdoc/template/base.html.twig | 14 ++++++++++++
 phpdoc.dist.xml                 | 38 +++++++++++++++++++++++++++++++++
 4 files changed, 54 insertions(+)
 create mode 100644 .phpdoc/guide/index.rst
 create mode 100644 .phpdoc/template/base.html.twig
 create mode 100644 phpdoc.dist.xml

diff --git a/.gitignore b/.gitignore
index fe915ae..60377ba 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,8 @@
+/.phpdoc/cache/
 /.vscode/
 /vendor/
 .php-cs-fixer.php
 composer.lock
 phpcs.xml
+phpdoc.xml
 phpstan.neon
diff --git a/.phpdoc/guide/index.rst b/.phpdoc/guide/index.rst
new file mode 100644
index 0000000..e69de29
diff --git a/.phpdoc/template/base.html.twig b/.phpdoc/template/base.html.twig
new file mode 100644
index 0000000..926c30b
--- /dev/null
+++ b/.phpdoc/template/base.html.twig
@@ -0,0 +1,14 @@
+{% extends 'layout.html.twig' %}
+
+{%
+set topMenu = {
+    "menu": [
+        { "name": "Packagist", "url": "https://packagist.org/packages/opencultureconsulting/basics"}
+    ],
+    "social": [
+        { "iconClass": "fab fa-github", "url": "https://github.com/opencultureconsulting/php-basics"},
+        { "iconClass": "fab fa-mastodon", "url": "https://openbiblio.social/@occ"},
+        { "iconClass": "fas fa-envelope-open-text", "url": "mailto:office@opencultureconsulting.com"}
+    ]
+}
+%}
diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml
new file mode 100644
index 0000000..394ebee
--- /dev/null
+++ b/phpdoc.dist.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdocumentor
+    configVersion="3"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://www.phpdoc.org"
+    xsi:schemaLocation="https://www.phpdoc.org https://raw.githubusercontent.com/phpDocumentor/phpDocumentor/master/data/xsd/phpdoc.xsd">
+    <title>PHP Basics</title>
+    <paths>
+        <output>doc</output>
+        <cache>.phpdoc/cache</cache>
+    </paths>
+    <version number="latest">
+        <api format="php">
+            <source dsn=".">
+                <path>/src</path>
+            </source>
+            <extensions>
+                <extension>php</extension>
+            </extensions>
+            <default-package-name>Basics</default-package-name>
+            <include-source>true</include-source>
+            <ignore-tags>
+                <ignore-tag>extends</ignore-tag>
+                <ignore-tag>implements</ignore-tag>
+                <ignore-tag>phpstan-require-implements</ignore-tag>
+            </ignore-tags>
+        </api>
+        <guide>
+            <source dsn=".">
+                <path>/.phpdoc/guide</path>
+            </source>
+            <output>guides</output>
+        </guide>
+    </version>
+    <setting name="graphs.enabled" value="true"/>
+    <setting name="guides.enabled" value="true"/>
+    <setting name="template.color" value="orange"/>
+</phpdocumentor>