Skip to content

Commit

Permalink
[TASK] Migrate docs to PHP-based rendering
Browse files Browse the repository at this point in the history
The Documentation Team introduced the PHP-based rendering (guides) as replacement for the
previously used Sphinx-based rendering (which is now deprecated).

This change migrates the configuration from Settings.cfg to guides.xml.

To generate the docs, a Composer script is introduced:

    composer docs:generate

Additionally, a new GitHub Workflow has been added which checks, if there are warnings or errors
on rendering of the documentation.

See: https://typo3.org/article/transition-to-full-php-based-rendering-for-all-typo3-extension-manuals
  • Loading branch information
brotkrueml committed Dec 4, 2024
1 parent f82bc02 commit ad39612
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 98 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Documentation

on:
push:
paths:
- 'Documentation/**'
pull_request:
paths:
- 'Documentation/**'


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

- name: Documentation renders without warnings
run: |
docker run --rm --pull always -v $(pwd):/project \
ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log
36 changes: 1 addition & 35 deletions Documentation/Includes.rst.txt
Original file line number Diff line number Diff line change
@@ -1,35 +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:: css(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
63 changes: 0 additions & 63 deletions Documentation/Settings.cfg

This file was deleted.

21 changes: 21 additions & 0 deletions Documentation/guides.xml
Original file line number Diff line number Diff line change
@@ -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-repository="https://github.com/tpwd/ke_search"
project-issues="https://github.com/tpwd/ke_search/issues"
edit-on-github-branch="master"
edit-on-github="tpwd/ke_search"
typo3-core-preferred="stable"
/>
<project
title="ke_search"
release="6.1.2"
version="6.1"
copyright="since 2011 by ke_search Dev Team"
/>
</guides>
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
"vendor-dir": ".Build/vendor"
},
"scripts": {
"docs:generate": "docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation",
"test:unit": ".Build/bin/phpunit -c Tests/phpunit.xml.dist",
"test:phpstan": ".Build/bin/phpstan clear-result-cache && .Build/bin/phpstan --configuration=Tests/phpstan.neon > phpstan-report.log",
"test:php-cs-fixer": ".Build/bin/php-cs-fixer fix -v --dry-run --using-cache=no > php-cs-fixer-report.log"
Expand Down

0 comments on commit ad39612

Please sign in to comment.