[DOCS] Migrate Documentation to the new rendering

dkd-kaehm · dkd-kaehm · commit 763fa1d70f7a · 2025-10-21T14:38:51.000+02:00
Fixes: #242 Ports: #243
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -23,8 +23,21 @@ jobs:
     name: Test docs
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
+      # Workaround for issue with actions/checkout@v4 wrong PR commit checkout: See https://github.com/actions/checkout/issues/299#issuecomment-677674415
+      -
+        name: Checkout current state of Pull Request
+        if: github.event_name == 'pull_request'
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+          ref: ${{ github.event.pull_request.head.sha }}
+      -
+        name: Checkout current state of Branch
+        if: github.event_name == 'push'
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+      # End: Workaround for issue with actions/checkout@v4 wrong PR commit checkout
 
       - name: Test if the documentation will render without warnings
         run: |
diff --git a/Documentation/Configuration/Check.rst b/Documentation/Configuration/Check.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Configuration
 ..  _configuration-tika-check:
 
diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
@@ -1,5 +1,3 @@
-..  include:: /Includes.rst.txt
-
 ..  _configuration:
 
 =============
diff --git a/Documentation/Configuration/SolrCell.rst b/Documentation/Configuration/SolrCell.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Configuration
 ..  _configuration-tika-solr-cell:
 
diff --git a/Documentation/Configuration/TikaAllServices.rst b/Documentation/Configuration/TikaAllServices.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Configuration
 ..  _configuration-tika-services:
 
diff --git a/Documentation/Configuration/TikaApp.rst b/Documentation/Configuration/TikaApp.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Configuration
 ..  _configuration-tika-app:
 
diff --git a/Documentation/Configuration/TikaServer.rst b/Documentation/Configuration/TikaServer.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Configuration
 ..  _configuration-tika-server:
 
diff --git a/Documentation/Editor/Index.rst b/Documentation/Editor/Index.rst
@@ -1,5 +1,3 @@
-..  include:: /Includes.rst.txt
-
 ..  _for-editors:
 
 ===========
diff --git a/Documentation/Includes.rst.txt b/Documentation/Includes.rst.txt
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -1,5 +1,3 @@
-..  include:: /Includes.rst.txt
-
 .. _start:
 
 =====================
@@ -79,4 +77,3 @@ Getting Help
     :hidden:
 
     Sitemap
-    genindex
diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst
@@ -1,5 +1,3 @@
-..  include:: /Includes.rst.txt
-
 ..  _introduction:
 
 ============
diff --git a/Documentation/Releases/10_0.rst b/Documentation/Releases/10_0.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Releases
 ..  _releases-tika-10_0:
 
diff --git a/Documentation/Releases/11_0.rst b/Documentation/Releases/11_0.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Releases
 ..  _releases-tika-11_0:
 
diff --git a/Documentation/Releases/12_0.rst b/Documentation/Releases/12_0.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Releases
 ..  _releases-tika-12_0:
 
diff --git a/Documentation/Releases/Archive/2_1.rst b/Documentation/Releases/Archive/2_1.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Releases
 ..  _releases-tika-2_1:
 
diff --git a/Documentation/Releases/Archive/2_2.rst b/Documentation/Releases/Archive/2_2.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Releases
 ..  _releases-tika-2_2:
 
diff --git a/Documentation/Releases/Archive/2_3.rst b/Documentation/Releases/Archive/2_3.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Releases
 ..  _releases-tika-2_3:
 
diff --git a/Documentation/Releases/Archive/2_4.rst b/Documentation/Releases/Archive/2_4.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Releases
 ..  _releases-tika-2_4:
 
diff --git a/Documentation/Releases/Archive/3_0.rst b/Documentation/Releases/Archive/3_0.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Releases
 ..  _releases-tika-3_0:
 
diff --git a/Documentation/Releases/Archive/3_1.rst b/Documentation/Releases/Archive/3_1.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Releases
 ..  _releases-tika-3_1:
 
diff --git a/Documentation/Releases/Archive/4_0.rst b/Documentation/Releases/Archive/4_0.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Releases
 ..  _releases-tika-4_0:
 
diff --git a/Documentation/Releases/Archive/5_0.rst b/Documentation/Releases/Archive/5_0.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Releases
 ..  _releases-tika-5_0:
 
diff --git a/Documentation/Releases/Archive/6_0.rst b/Documentation/Releases/Archive/6_0.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Releases
 ..  _releases-tika-6_0:
 
diff --git a/Documentation/Releases/Archive/Index.rst b/Documentation/Releases/Archive/Index.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Archive
 .. _releases-archive:
 
diff --git a/Documentation/Releases/Index.rst b/Documentation/Releases/Index.rst
@@ -1,4 +1,3 @@
-..  include:: /Includes.rst.txt
 ..  index:: Releases
 .. _releases:
 
diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg
diff --git a/Documentation/Sitemap.rst b/Documentation/Sitemap.rst
@@ -1,7 +1,5 @@
 :template: sitemap.html
 
-..  include:: /Includes.rst.txt
-
 =======
 Sitemap
 =======
diff --git a/Documentation/genindex.rst b/Documentation/genindex.rst
diff --git a/Documentation/guides.xml b/Documentation/guides.xml
@@ -0,0 +1,26 @@
+<?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"
+	  interlink-shortcode="apache-solr-for-typo3/tika"
+	  project-home="https://www.typo3-solr.com"
+	  project-contact="info@dkd.de"
+	  project-repository="https://github.com/TYPO3-Solr/ext-tika"
+	  project-issues="https://github.com/TYPO3-Solr/ext-tika/issues"
+	  project-discussions="https://typo3.slack.com/archives/C02FF05Q4"
+	  edit-on-github-branch="release-12.0.x"
+	  edit-on-github="TYPO3-Solr/ext-tika"
+	  typo3-core-preferred="12.4"
+  />
+  <project
+	  title="Apache Tika for TYPO3"
+	  release="12.0"
+	  version="12.0"
+	  copyright="since 2009 by dkd &amp; contributors"
+  />
+</guides>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-.. include:: /Includes.rst.txt`
`2`	`1`	`.. index:: Configuration`
`3`	`2`	`.. _configuration-tika-check:`
`4`	`3`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-.. include:: /Includes.rst.txt`
`2`		`-`
`3`	`1`	`.. _configuration:`
`4`	`2`
`5`	`3`	`=============`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-.. include:: /Includes.rst.txt`
`2`		`-`
`3`	`1`	`.. _for-editors:`
`4`	`2`
`5`	`3`	`===========`