Skip to content

Commit

Permalink
[DOCS] Switch workspaces 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 outdated genindex: not supported anymore
* Remove old Settings.cfg, was only used for Sphinx

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

Resolves: #103342
Releases: main, 12.4, 11.5
Change-Id: I8d29012e8be9e999129d04c5e84d6a531a9a6b28
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83354
Reviewed-by: Chris Müller <typo3@krue.ml>
Tested-by: core-ci <typo3@b13.com>
Tested-by: Chris Müller <typo3@krue.ml>
Tested-by: Lina Wolf <112@linawolf.de>
Reviewed-by: Lina Wolf <112@linawolf.de>
  • Loading branch information
linawolf committed Mar 8, 2024
1 parent cdf70fe commit bc275e3
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 107 deletions.
35 changes: 1 addition & 34 deletions typo3/sysext/workspaces/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 PHP syntax highlighting
.. highlight:: php
.. You can put central messages to display on all pages here
3 changes: 2 additions & 1 deletion typo3/sysext/workspaces/Documentation/Index.rst
@@ -1,5 +1,7 @@
.. include:: /Includes.rst.txt

.. _start:

================
TYPO3 Workspaces
================
Expand Down Expand Up @@ -51,4 +53,3 @@ granular editing and publishing process.
:hidden:

Sitemap
genindex
65 changes: 0 additions & 65 deletions typo3/sysext/workspaces/Documentation/Settings.cfg

This file was deleted.

7 changes: 0 additions & 7 deletions typo3/sysext/workspaces/Documentation/genindex.rst

This file was deleted.

21 changes: 21 additions & 0 deletions typo3/sysext/workspaces/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/workspaces/"
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="main"
edit-on-github="typo3/typo3"
edit-on-github-directory="typo3/sysext/workspaces/Documentation/"
typo3-core-preferred="main"
interlink-shortcode="typo3/cms-workspaces"
/>
<project title="Workspaces"
release="main (development)"
version="main (development)"
copyright="since 2010 by the TYPO3 contributors"
/>
</guides>

0 comments on commit bc275e3

Please sign in to comment.