Merge pull request #1202 from linawolf/docs/switch-rendering

[DOCS] Switch Documentation Rendering to PHP

.github/workflows/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/ForAdministrators/Templates/Changing/Index.rst

@@ -50,4 +50,4 @@ now required to use TSConfig::
 
   templates.derhansen/sf_event_mgt.20 = derhansen/sf_event_mgt_extend_demo:Resources/Private
 
-Details see :doc:`changelog entry<Feature-96812-OverrideBackendTemplatesWithTSconfig>`
+Details see :ref:`changelog entry <changelog:feature-96812>`

Documentation/Includes.rst.txt

@@ -1,35 +1 @@
-.. More information about this file:
-.. https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt
-
-.. ----------
-.. text roles
-.. ----------
-
-.. role:: aspect(emphasis)
-.. role:: bash(code)
-.. role:: css(code)
-.. role:: html(code)
-.. role:: js(code)
-.. role:: php(code)
-.. role:: rst(code)
-.. role:: sep(strong)
-.. role:: sql(code)
-
-.. role:: tsconfig(code)
-  :class: typoscript
-
-.. role:: typoscript(code)
-.. role:: xml(code)
-  :class: html
-
-.. role:: yaml(code)
-
-.. default-role:: code
-
-.. ---------
-.. highlight
-.. ---------
-
-.. By default, code blocks use PHP syntax highlighting
-
-.. highlight:: php
+..  You can put central messages to display on all pages here

Documentation/Index.rst

@@ -137,25 +137,18 @@ TYPO3 CMS.
          .. container:: card-body
 
             Various extensions improve ext:sf_event_mgt with additional features.
-.. Table of Contents
-
-.. toctree::
-   :maxdepth: 5
-   :titlesonly:
-   :hidden:
-
-   Introduction/Index
-   ForEditors/Index
-   ForAdministrators/Index
-   ForDevelopers/Index
-   Faq/Index
-   Reference/Index
-   Miscellaneous/Index
 
-.. Meta Menu
-
-.. toctree::
-   :hidden:
+.. Table of Contents
 
-   Sitemap
-   genindex
+..  toctree::
+    :maxdepth: 5
+    :titlesonly:
+    :hidden:
+
+    Introduction/Index
+    ForEditors/Index
+    ForAdministrators/Index
+    ForDevelopers/Index
+    Faq/Index
+    Reference/Index
+    Addons/Index

Documentation/Reference/MigrationFromSeminars/Index.rst

@@ -30,7 +30,7 @@ SQL queries
 
 We are starting with a fresh install of sf_event_mgt so we can use ids mostly 1 to 1.
 
-.. code-block:: mysql
+.. code-block:: sql
 
     /* Organizers */
     INSERT INTO tx_sfeventmgt_domain_model_organisator (uid,pid,name,email,email_signature)

Documentation/guides.xml

@@ -0,0 +1,18 @@
+<?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/derhansen/sf_event_mgt" project-contact="mailto:[email protected]"
+               project-repository="https://github.com/derhansen/sf_event_mgt"
+               project-issues="https://github.com/derhansen/sf_event_mgt/issues"
+               edit-on-github-branch="master"
+               edit-on-github="derhansen/sf_event_mgt"
+               typo3-core-preferred="stable"
+               interlink-shortcode="derhansen/sf_event_mgt"
+    />
+    <project title="Event management and registration"
+             release="7.2.0"
+             version="7.0"
+             copyright="2014 - 2023 by Torben Hansen"/>
+</guides>

Makefile

@@ -0,0 +1,16 @@
+.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 docs (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