Skip to content

Commit

Permalink
[DOCS] Switch Reactions documentation to PHP-based rendering
Browse files Browse the repository at this point in the history
* Introduce a guides.xml, the presence of this file
  triggers the new rendering.
* Remove old Settings.cfg, was only used for Sphinx

Attention: Backport needs manual changes to the guides.xml.

This manual exists since TYPO3 v12

Resolves: #103332
Releases: main, 12.4
Change-Id: Ief1b99941b36f76189281423caa9f5badd292711
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83346
Tested-by: core-ci <typo3@b13.com>
Reviewed-by: Lina Wolf <112@linawolf.de>
Tested-by: Lina Wolf <112@linawolf.de>
  • Loading branch information
linawolf committed Mar 8, 2024
1 parent 0cd5ef5 commit 10b2d85
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 103 deletions.
33 changes: 1 addition & 32 deletions typo3/sysext/reactions/Documentation/Includes.rst.txt
@@ -1,32 +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 PHP syntax highlighting
.. You can put central messages to display on all pages here
71 changes: 0 additions & 71 deletions typo3/sysext/reactions/Documentation/Settings.cfg

This file was deleted.

20 changes: 20 additions & 0 deletions typo3/sysext/reactions/Documentation/guides.xml
@@ -0,0 +1,20 @@
<?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/reactions/"
project-contact="https://typo3.slack.com/archives/C025BQLFA"
project-repository="https://github.com/typo3/typo3"
project-issues="https://forge.typo3.org/projects/typo3cms-core/issues"
edit-on-github-branch="12.4"
edit-on-github="typo3/typo3"
edit-on-github-directory="typo3/sysext/reactions/Documentation/"
typo3-core-preferred="12.4"
interlink-shortcode="typo3/cms-reactions"
/>
<project title="Reactions"
release="12.4"
version="12.4"
copyright="since 2022 by the TYPO3 contributors"/>
</guides>

0 comments on commit 10b2d85

Please sign in to comment.