Merge pull request #53 from Alagts/task-rendering

[TASK] Switch Documentation Rendering to PHP

Author: bmack

.editorconfig

@@ -18,3 +18,8 @@ trim_trailing_whitespace = true
 indent_style = space
 indent_size = 4
 max_line_length = 80
+
+# 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 --fail-on-log

Documentation/Index.rst

@@ -54,4 +54,3 @@ own extension, which got its own public repository.
    :hidden:
 
    Sitemap
-   genindex

Documentation/Settings.cfg

@@ -0,0 +1,25 @@
+<?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://extensions.typo3.org/extension/jumpurl"
+               project-contact="https://typo3.slack.com/archives/C025BQLFA"
+               project-repository="https://github.com/FriendsOfTYPO3/jumpurl"
+               project-issues="https://github.com/FriendsOfTYPO3/jumpurl/issues"
+               edit-on-github-branch="master"
+               edit-on-github="FriendsOfTYPO3/jumpurl"
+               typo3-core-preferred="11.5"
+               interlink-shortcode="friendsoftypo3/jumpurl"
+    />
+    <project title="Jump URL"
+             release="main (development)"
+             version="main (development)"
+             copyright="since 1997 by the TYPO3 contributors"
+    />
+    <inventory id="t3tsref-v9"
+               url="https://docs.typo3.org/m/typo3/reference-typoscript/9.5/en-us/"
+    />
+</guides>

Documentation/genindex.rst

@@ -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 --fail-on-log