Merge pull request #40 from Alagts/task/rendering

[TASK] Switch to PHP-based Documentation Rendering

.editorconfig

@@ -69,3 +69,8 @@ indent_size = 4
 
 [*.neon]
 indent_style = tab
+
+# Makefile
+[{Makefile,**.mk}]
+# Use tabs for indentation (Makefiles require tabs)
+indent_style = tab

.github/workflows/test-documentation.yml

@@ -0,0 +1,17 @@
+name: test documentation
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    name: documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Test if the documentation will render without warnings
+        run: |
+          mkdir -p Documentation-GENERATED-temp \
+          && docker run --rm --pull always -v $(pwd):/project \
+             ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --minimal-test

.gitignore

@@ -4,3 +4,5 @@ config/
 var/
 *.cache
 composer.lock
+.idea/
+Documentation-GENERATED-temp/

Documentation/Includes.txt

@@ -1,13 +1 @@
-.. This is 'Includes.txt'. It is included at the very top of each and
-.. every ReST source file in this documentation project (= manual).
-
-.. role::   typoscript(code)
-
-.. role::   ts(typoscript)
-   :class:  typoscript
-
-.. role::   php(code)
-
-.. highlight:: php
-
-.. default-role:: code
+.. You can put central messages to display on all pages here

Documentation/Index.rst

@@ -51,6 +51,3 @@ a GNU/GPL CMS/Framework available from http://typo3.org
 
    Introduction/Index
    Installation/Index
-   Configuration/Index
-   Breaking/Index
-   Testing/Index

Documentation/guides.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<guides xmlns="https://www.phpdoc.org/guides"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd"
+        links-are-relative="true"
+>
+    <extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
+               project-home="https://github.com/evoWeb/sessionplaner"
+               project-repository="https://github.com/evoWeb/sessionplaner"
+               project-issues="https://github.com/evoWeb/sessionplaner/issues"
+               edit-on-github-branch="develop"
+               edit-on-github="evoweb/sessionplaner"
+               typo3-core-preferred="stable"
+               interlink-shortcode="evoweb/sessionplaner"
+    />
+    <project title="sessionplaner"
+             release="4.0.0"
+             copyright="since 2013 by evoWeb"
+    />
+</guides>

Makefile

@@ -0,0 +1,14 @@
+.PHONY: help
+help: ## Displays this list of targets with descriptions
+    @echo "The following commands are available:\n"
+    @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: docs
+docs: ## Generate projects documentation (from "Documentation" directory)
+	mkdir -p Documentation-GENERATED-temp
+	docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
+
+.PHONY: test-docs
+test-docs: ## Test the documentation rendering
+	mkdir -p Documentation-GENERATED-temp
+	docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --minimal-test