Skip to content

Commit

Permalink
[TASK] Switch to PHP-based rendering
Browse files Browse the repository at this point in the history
12,4 and 11.5 will need manual backports

releases: main
  • Loading branch information
linawolf committed Mar 25, 2024
1 parent c62b8c8 commit 9303abd
Show file tree
Hide file tree
Showing 9 changed files with 56 additions and 352 deletions.
17 changes: 17 additions & 0 deletions .github/workflows/test-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: test documentation

on: [ push, pull_request ]

jobs:
tests:
name: documentation
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Test if the documentation will render without warnings
run: |
mkdir -p Documentation-GENERATED-temp \
&& docker run --rm --pull always -v $(pwd):/project \
ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ would be the page record and all fields of the :typoscript:`pages` table
are available.

All examples base on :typoscript:`lib.contentElement`, which is provided by
the system extension :doc:`fluid_styled_content <ext_fsc:Index>`.
the system extension :doc:`fluid_styled_content <typo3/cms-fluid-styled-content:Index>`.

In this system extension it is defined as follows:

Expand Down
35 changes: 1 addition & 34 deletions Documentation/Includes.rst.txt
Original file line number Diff line number Diff line change
@@ -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:: typoscript
.. You can put central messages to display on all pages here
1 change: 0 additions & 1 deletion Documentation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,3 @@ chapter of TYPO3 Explained.
Glossary
About
Sitemap
genindex
66 changes: 0 additions & 66 deletions Documentation/Settings.cfg

This file was deleted.

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

This file was deleted.

20 changes: 20 additions & 0 deletions Documentation/guides.xml
Original file line number Diff line number Diff line change
@@ -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://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/"
project-contact="https://typo3.slack.com/archives/C028JEPJL"
project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-Typoscript"
project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-Typoscript/issues"
edit-on-github-branch="main"
edit-on-github="TYPO3-Documentation/TYPO3CMS-Reference-Typoscript"
typo3-core-preferred="main"
interlink-shortcode="t3tsref"
/>
<project title="TypoScript Reference"
release="main (development)"
version="main (development)"
copyright="since 2012 by the TYPO3 contributors"
/>
</guides>
Loading

0 comments on commit 9303abd

Please sign in to comment.