[TASK] Fix documentation rendering

Resolves: #722
TYPO3-Headless · May 17, 2024 · 8b4a32d · 8b4a32d
1 parent 56cc23f
commit 8b4a32d
Show file tree

Hide file tree

Showing 12 changed files with 26 additions and 111 deletions.
diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
@@ -1,5 +1,3 @@
-.. include:: ../Includes.txt
-
 .. _configuration:
 
 ===================

diff --git a/Documentation/Configuration/Preview.rst b/Documentation/Configuration/Preview.rst
@@ -1,5 +1,3 @@
-.. include:: ../Includes.txt
-
 .. _preview:
 
 ===================

diff --git a/Documentation/Developer/Images.rst b/Documentation/Developer/Images.rst
@@ -1,5 +1,3 @@
-.. include:: ../Includes.txt
-
 .. _images:
 
 ===================

diff --git a/Documentation/Developer/Index.rst b/Documentation/Developer/Index.rst
@@ -1,5 +1,3 @@
-.. include:: ../Includes.txt
-
 .. _developer:
 
 ===============

diff --git a/Documentation/FAQ/Index.rst b/Documentation/FAQ/Index.rst
@@ -1,5 +1,3 @@
-.. include:: ../Includes.txt
-
 .. _faq:
 
 ===============

diff --git a/Documentation/Includes.txt b/Documentation/Includes.txt
diff --git a/Documentation/Installation/Index.rst b/Documentation/Installation/Index.rst
@@ -1,5 +1,3 @@
-.. include:: ../Includes.txt
-
 .. _installation:
 
 ==============
@@ -19,7 +17,7 @@ After TYPO3 is running, we can continue installing the headless extension:
       :class: with-shadow
 
 #. **Create a new root template:** Open the backend's menu entry *Site Management* > *TypoScript* (before v12: *Web* > *Template*). Add "`headless`" to "Include static (from extensions)". After saving and displaying
-   the page, we can see already the JSON output. 
+   the page, we can see already the JSON output.
 
 #. **Create a site configuration:** The site URL is needed as endpoint URL for the frontend.
    In TYPO3 v10 an autogenerated site configuration might exist which we can rename and configure to our preferences.

diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst
@@ -1,15 +1,11 @@
-.. include:: ../Includes.txt
-
 .. _introduction:
 
 ==============
 Introduction
 ==============
 
-.. Info::
-
-   This extension is part of the `TYPO3 PWA Initiative <https://typo3.org/community/teams/typo3-development/initiatives/pwa/>`__
-   and is still in an early stage of development.
+This extension is part of the `TYPO3 PWA Initiative <https://typo3.org/community/teams/typo3-development/initiatives/pwa/>`__
+and is still in an early stage of development.
 
 .. _what-it-does:
 

diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg
diff --git a/Documentation/guides.xml b/Documentation/guides.xml
@@ -0,0 +1,21 @@
+<?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/headless/"
+               project-contact="https://typo3.slack.com/archives/CDJK80WV6"
+               project-repository="https://github.com/TYPO3-Headless/headless/"
+               project-issues="https://github.com/TYPO3-Headless/headless/issues"
+               edit-on-github-branch="master"
+               edit-on-github="TYPO3-Headless/headless"
+               edit-on-github-directory="Documentation/"
+               typo3-core-preferred="12.4"
+               interlink-shortcode="friendsoftypo3/headless"
+    />
+    <project title="Headless"
+             release="4.3"
+             version="4.3"
+             copyright="TYPO3 Headless"
+    />
+</guides>
diff --git a/composer.json b/composer.json
@@ -126,14 +126,7 @@
       ".Build/vendor/bin/typoscript-lint -c Configuration/TsLint.yml --ansi -n --fail-on-warnings -vvv Configuration/TypoScript"
     ],
     "ci:yaml:lint": "find . ! -path '*.Build/*' -name '*.yml' | xargs php ./.Build/vendor/bin/yaml-lint",
-    "docs:generate": [
-      "@docs:generate:pullimage",
-      "docker run --rm ghcr.io/t3docs/render-documentation show-shell-commands > tempfile.sh; echo 'dockrun_t3rd makehtml' >> tempfile.sh; bash tempfile.sh; rm tempfile.sh"
-    ],
-    "docs:generate:pullimage": [
-      "docker pull ghcr.io/t3docs/render-documentation",
-      "docker tag ghcr.io/t3docs/render-documentation t3docs/render-documentation"
-    ],
+    "docs:generate": "docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation",
     "fix:php:cs-fixer": [
       "php-cs-fixer fix -v --using-cache no --config .php-cs-fixer.php"
     ],

diff --git a/ext_emconf.php b/ext_emconf.php
@@ -15,7 +15,7 @@
     'author_email' => 'extensions@macopedia.pl',
     'author_company' => 'Macopedia Sp. z o.o.',
     'category' => 'fe',
-    'version' => '4.2.7',
+    'version' => '4.3.0',
     'constraints' => [
         'depends' => [
             'frontend' => '12.4.3-12.5.99',