[TASK] Switch the manual to the PHP-based rendered (#730)

Fixes #609
oliverklee · Nov 23, 2024 · bf36aaf · bf36aaf
1 parent 827305d
commit bf36aaf
Show file tree

Hide file tree

Showing 10 changed files with 725 additions and 146 deletions.
diff --git a/Build/Scripts/runTests.sh b/Build/Scripts/runTests.sh
diff --git a/Documentation/AddedFields.rst b/Documentation/AddedFields.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _added-fields:
 
 ==================================

diff --git a/Documentation/ExtbaseModels.rst b/Documentation/ExtbaseModels.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _extbase-models:
 
 ========================
@@ -16,9 +14,3 @@ This extension provides the following Extbase models and repositories:
 These models and repositories can also be used as drop-in replacements for the
 :php:`FrontEndUser` model and repository that were deprecated in TYPO3 V11 and
 will be/have been removed in TYPO3 V12.
-
-Validation
-==========
-
-Please note that the models do not provide any validation for their
-properties (as the validation is expected to be specific to each application).
diff --git a/Documentation/Includes.rst.txt b/Documentation/Includes.rst.txt
@@ -1,34 +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:: 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 automatically detected syntax highlighting
-
-.. highlight:: guess
+.. You can put central messages to display on all pages here
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -1,10 +1,6 @@
-.. include:: /Includes.rst.txt
-
-.. _start:
-
-=====================================
+============================
 TYPO3 extension ``feuserextrafields``
-=====================================
+============================
 
 :Extension key:
    feuserextrafields
@@ -28,14 +24,7 @@ TYPO3 extension ``feuserextrafields``
 :Rendered:
    |today|
 
-----
-
-This TYPO3 extension adds additional common fields to FE users
-and provides Extbase models for this (like the `sr_feuser_register` and
-`sf_register` extensions do, but without the additional registering
-functionality).
-
-----
+The content of this document is related to TYPO3 - a GNU/GPL CMS/Framework available from www.typo3.org
 
 **Table of Contents:**
 
@@ -47,9 +36,3 @@ functionality).
    AddedFields
 
 .. Meta Menu
-
-.. toctree::
-   :hidden:
-
-   Sitemap
-   genindex
diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg
diff --git a/Documentation/Sitemap.rst b/Documentation/Sitemap.rst
diff --git a/Documentation/genindex.rst b/Documentation/genindex.rst
diff --git a/Documentation/guides.xml b/Documentation/guides.xml
@@ -0,0 +1,13 @@
+<?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/feuserextrafields"
+               project-contact="mailto:[email protected]"
+               project-repository="https://github.com/oliverklee/ext-feuserextrafields"
+               project-issues="https://github.com/oliverklee/ext-feuserextrafields/issues" edit-on-github-branch="main"
+               edit-on-github="oliverklee/ext-feuserextrafields" typo3-core-preferred="stable"
+               interlink-shortcode="oliverklee/feuserextrafields"/>
+    <project title="feuserextrafields" release="6.3.0" version="6.3" copyright="2024"/>
+</guides>
diff --git a/composer.json b/composer.json
@@ -142,9 +142,6 @@
 		"ci:xliff:lint": "php Build/bin/console lint:xliff Resources/Private/Language",
 		"ci:yaml:lint": "find . ! -path '*.Build/*' \\( -name '*.yaml' -o -name '*.yml' \\) | xargs -r php ./.Build/vendor/bin/yaml-lint",
 		"coverage:create-directories": "mkdir -p build/logs .Build/coverage",
-		"docs:generate": [
-			"docker run --rm t3docs/render-documentation show-shell-commands > tempfile.sh; echo 'dockrun_t3rd makehtml' >> tempfile.sh; bash tempfile.sh; rm tempfile.sh"
-		],
 		"fix": [
 			"@fix:composer",
 			"@fix:php"
@@ -194,7 +191,6 @@
 		"ci:xliff:lint": "Lints the XLIFF files.",
 		"ci:yaml:lint": "Lints the YAML files.",
 		"coverage:create-directories": "Creates the directories needed for recording and merging the code coverage reports.",
-		"docs:generate": "Renders the extension ReST documentation.",
 		"fix": "Runs all automatic code style fixes.",
 		"fix:composer": "Normalizes all composer.json files.",
 		"fix:php": "Runs all fixers for the PHP code.",