diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 370ad2ac..2b847f67 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -31,6 +31,18 @@ jobs: - name: PHP lint run: "find *.php Classes Configuration Tests -name '*.php' -print0 | xargs -0 -n 1 -P 4 php -l" + documentation-rendering: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Documentation 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 + coding-guideline: runs-on: ubuntu-latest needs: diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 9b7ca8ed..dd045ebb 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -196,17 +196,15 @@ test:codception:php83:typo3_12: documentation: stage: documentation image: - name: t3docs/render-documentation:v2.4.0 - entrypoint: [""] - before_script: - - cp -a ${CI_PROJECT_DIR}/. /PROJECT - - mkdir -p ${CI_PROJECT_DIR}/Documentation-GENERATED-temp + name: ghcr.io/typo3-documentation/render-guides:latest + entrypoint: [ "" ] script: - - cd /ALL/venv - - /ALL/Menu/mainmenu.sh makehtml-no-cache -c resultdir ${CI_PROJECT_DIR}/Documentation-GENERATED-temp + - mkdir -p Documentation-GENERATED-temp + - /opt/guides/entrypoint.sh --config=Documentation --no-progress --fail-on-log + before_script: [] artifacts: paths: - - ${CI_PROJECT_DIR}/Documentation-GENERATED-temp/Result/project/0.0.0 + - Documentation-GENERATED-temp/ expire_in: 1 day when: always diff --git a/Documentation/AdministratorManual/Configuration/Index.rst b/Documentation/Administrator/Configuration/Index.rst similarity index 64% rename from Documentation/AdministratorManual/Configuration/Index.rst rename to Documentation/Administrator/Configuration/Index.rst index 1c2a75e9..fafff081 100644 --- a/Documentation/AdministratorManual/Configuration/Index.rst +++ b/Documentation/Administrator/Configuration/Index.rst @@ -1,5 +1,6 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt +============= Configuration ============= diff --git a/Documentation/AdministratorManual/Configuration/Main/Index.rst b/Documentation/Administrator/Configuration/Main/Index.rst similarity index 94% rename from Documentation/AdministratorManual/Configuration/Main/Index.rst rename to Documentation/Administrator/Configuration/Main/Index.rst index 5591a100..e66abf9d 100644 --- a/Documentation/AdministratorManual/Configuration/Main/Index.rst +++ b/Documentation/Administrator/Configuration/Main/Index.rst @@ -1,5 +1,6 @@ -.. include:: ../../../Includes.txt +.. include:: ../../../Includes.rst.txt +================== Main Configuration ================== diff --git a/Documentation/Administrator/Index.rst b/Documentation/Administrator/Index.rst new file mode 100644 index 00000000..da56e0c5 --- /dev/null +++ b/Documentation/Administrator/Index.rst @@ -0,0 +1,14 @@ +.. include:: ../Includes.rst.txt + +.. _administrator: + +================== +For Administrators +================== + +.. toctree:: + :maxdepth: 5 + :titlesonly: + + Installation/Index + Configuration/Index diff --git a/Documentation/AdministratorManual/Installation/Index.rst b/Documentation/Administrator/Installation/Index.rst similarity index 95% rename from Documentation/AdministratorManual/Installation/Index.rst rename to Documentation/Administrator/Installation/Index.rst index b9441841..bd191060 100644 --- a/Documentation/AdministratorManual/Installation/Index.rst +++ b/Documentation/Administrator/Installation/Index.rst @@ -1,5 +1,6 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt +============ Installation ============ diff --git a/Documentation/AdministratorManual/Index.rst b/Documentation/AdministratorManual/Index.rst deleted file mode 100644 index 6ce92e5c..00000000 --- a/Documentation/AdministratorManual/Index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. include:: ../Includes.txt - -Administrator Manual -==================== - -.. toctree:: - :maxdepth: 5 - :titlesonly: - - Installation/Index - Configuration/Index diff --git a/Documentation/Changelog/1.0/Index.rst b/Documentation/Changelog/1.0/Index.rst index 945197e7..628370f3 100644 --- a/Documentation/Changelog/1.0/Index.rst +++ b/Documentation/Changelog/1.0/Index.rst @@ -1,6 +1,7 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt +=========== 1.0 Changes =========== -The version 1.0.0 is a release for TYPO3 v8.7 only and skipped for TYPO3 v9. `2.0 Changes <../2.0/Index.html>`_. +The version 1.0.0 is a release for TYPO3 v8.7 only and skipped for TYPO3 v9.5. This version is compatible to Cart v5.0+. diff --git a/Documentation/Changelog/2.0/Index.rst b/Documentation/Changelog/2.0/Index.rst index 11f6488b..0740fd52 100644 --- a/Documentation/Changelog/2.0/Index.rst +++ b/Documentation/Changelog/2.0/Index.rst @@ -1,9 +1,10 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt +=========== 2.0 Changes =========== -This is the initial release of cart_events for TYPO3 v9.5. It is part of the cart extension. +The version 2.0.0 is a release for TYPO3 v9.5 only. This version is compatible to Cart v6.0+. .. IMPORTANT:: **If upgrading from cart version 4.8.1 or earlier: Please read the documentation very carefully! Please make a backup of your filesystem and database!** If possible test the update in a test copy of your TYPO3 instance. \ No newline at end of file diff --git a/Documentation/Changelog/2.1/Feature-26-AddToCartFormFrameworkFinisher.rst b/Documentation/Changelog/2.1/Feature-26-AddToCartFormFrameworkFinisher.rst index af822386..15f07c7e 100644 --- a/Documentation/Changelog/2.1/Feature-26-AddToCartFormFrameworkFinisher.rst +++ b/Documentation/Changelog/2.1/Feature-26-AddToCartFormFrameworkFinisher.rst @@ -1,4 +1,4 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt ==================================================== Feature: #26 - Add addToCart form framework finisher diff --git a/Documentation/Changelog/2.1/Feature-33-AddKeSearchIndexer.rst b/Documentation/Changelog/2.1/Feature-33-AddKeSearchIndexer.rst index 95b55e62..53949d1d 100644 --- a/Documentation/Changelog/2.1/Feature-33-AddKeSearchIndexer.rst +++ b/Documentation/Changelog/2.1/Feature-33-AddKeSearchIndexer.rst @@ -1,4 +1,4 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt ==================================== Feature: #33 - Add ke_search indexer diff --git a/Documentation/Changelog/2.1/Important-38-RenderEventDateInShowTemplate.rst b/Documentation/Changelog/2.1/Important-38-RenderEventDateInShowTemplate.rst index ad8be94b..1525e02c 100644 --- a/Documentation/Changelog/2.1/Important-38-RenderEventDateInShowTemplate.rst +++ b/Documentation/Changelog/2.1/Important-38-RenderEventDateInShowTemplate.rst @@ -1,4 +1,4 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt =================================================================== Important: #38 - Render begin and end of eventDate in show template diff --git a/Documentation/Changelog/2.1/Index.rst b/Documentation/Changelog/2.1/Index.rst index 3cc752da..b04e204e 100644 --- a/Documentation/Changelog/2.1/Index.rst +++ b/Documentation/Changelog/2.1/Index.rst @@ -1,5 +1,6 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt +=========== 2.1 Changes =========== diff --git a/Documentation/Changelog/2.3/Breaking-36-AddPriceCategories.rst b/Documentation/Changelog/2.3/Breaking-36-AddPriceCategories.rst index 813f21be..d25d4d4c 100644 --- a/Documentation/Changelog/2.3/Breaking-36-AddPriceCategories.rst +++ b/Documentation/Changelog/2.3/Breaking-36-AddPriceCategories.rst @@ -1,4 +1,4 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt ==================================== Breaking: #36 - Add price categories diff --git a/Documentation/Changelog/2.3/Feature-36-AddPriceCategories.rst b/Documentation/Changelog/2.3/Feature-36-AddPriceCategories.rst index 95486195..6a77a2a2 100644 --- a/Documentation/Changelog/2.3/Feature-36-AddPriceCategories.rst +++ b/Documentation/Changelog/2.3/Feature-36-AddPriceCategories.rst @@ -1,4 +1,4 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt =================================== Feature: #36 - Add price categories diff --git a/Documentation/Changelog/2.3/Index.rst b/Documentation/Changelog/2.3/Index.rst index 78a69bb1..0378c39b 100644 --- a/Documentation/Changelog/2.3/Index.rst +++ b/Documentation/Changelog/2.3/Index.rst @@ -1,5 +1,6 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt +=========== 2.3 Changes =========== diff --git a/Documentation/Changelog/2.4/Feature-59-AddHookToAllowChangingTheProduct.rst b/Documentation/Changelog/2.4/Feature-59-AddHookToAllowChangingTheProduct.rst index 5d839cfc..0e4543ec 100644 --- a/Documentation/Changelog/2.4/Feature-59-AddHookToAllowChangingTheProduct.rst +++ b/Documentation/Changelog/2.4/Feature-59-AddHookToAllowChangingTheProduct.rst @@ -1,4 +1,4 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt ===================================================== Feature: #59 - Add Hook to Allow Changing the Product diff --git a/Documentation/Changelog/2.4/Index.rst b/Documentation/Changelog/2.4/Index.rst index 5335cf3a..efa18ebb 100644 --- a/Documentation/Changelog/2.4/Index.rst +++ b/Documentation/Changelog/2.4/Index.rst @@ -1,5 +1,6 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt +=========== 2.4 Changes =========== diff --git a/Documentation/Changelog/3.0/Index.rst b/Documentation/Changelog/3.0/Index.rst index 12d13114..79636d5a 100644 --- a/Documentation/Changelog/3.0/Index.rst +++ b/Documentation/Changelog/3.0/Index.rst @@ -1,5 +1,6 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt +=========== 3.0 Changes =========== diff --git a/Documentation/Changelog/4.0/Breaking-64-MoveFluidPaginationToController.rst b/Documentation/Changelog/4.0/Breaking-64-MoveFluidPaginationToController.rst index 86f6e3cf..c55ff23f 100644 --- a/Documentation/Changelog/4.0/Breaking-64-MoveFluidPaginationToController.rst +++ b/Documentation/Changelog/4.0/Breaking-64-MoveFluidPaginationToController.rst @@ -1,4 +1,4 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt =================================================== Breaking: #64 - Move Fluid Pagination to Controller diff --git a/Documentation/Changelog/4.0/Feature-64-AddPaginationToController.rst b/Documentation/Changelog/4.0/Feature-64-AddPaginationToController.rst index 2c8dc58c..7b27c6e5 100644 --- a/Documentation/Changelog/4.0/Feature-64-AddPaginationToController.rst +++ b/Documentation/Changelog/4.0/Feature-64-AddPaginationToController.rst @@ -1,4 +1,4 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt ============================================ Breaking: #64 - Add Pagination to Controller diff --git a/Documentation/Changelog/4.0/Index.rst b/Documentation/Changelog/4.0/Index.rst index df189e31..02c52067 100644 --- a/Documentation/Changelog/4.0/Index.rst +++ b/Documentation/Changelog/4.0/Index.rst @@ -1,5 +1,6 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt +=========== 4.0 Changes =========== diff --git a/Documentation/Changelog/5.0/Index.rst b/Documentation/Changelog/5.0/Index.rst new file mode 100644 index 00000000..63b62e32 --- /dev/null +++ b/Documentation/Changelog/5.0/Index.rst @@ -0,0 +1,11 @@ +.. include:: ../../Includes.rst.txt + +=========== +5.0 Changes +=========== + +**Table of contents** + +.. contents:: + :local: + :depth: 1 \ No newline at end of file diff --git a/Documentation/Changelog/Index.rst b/Documentation/Changelog/Index.rst index 14c37879..c3c839ba 100644 --- a/Documentation/Changelog/Index.rst +++ b/Documentation/Changelog/Index.rst @@ -1,5 +1,6 @@ -.. include:: ../Includes.txt +.. include:: ../Includes.rst.txt +========= ChangeLog ========= @@ -7,6 +8,7 @@ ChangeLog :maxdepth: 5 :titlesonly: + 5.0/Index 4.0/Index 3.0/Index 2.4/Index diff --git a/Documentation/Includes.txt b/Documentation/Includes.rst.txt similarity index 100% rename from Documentation/Includes.txt rename to Documentation/Includes.rst.txt diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 2acf2bb6..8680b0a8 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -1,10 +1,10 @@ -.. include:: Includes.txt +.. include:: Includes.rst.txt .. _start: -=========================== +================ EXT: Cart Events -=========================== +================ .. image:: Images/cart_events_logo.png :height: 200 @@ -52,5 +52,5 @@ EXT: Cart Events :titlesonly: Introduction/Index - AdministratorManual/Index + Administrator/Index Changelog/Index diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst index 5088edf9..2ae9a526 100644 --- a/Documentation/Introduction/Index.rst +++ b/Documentation/Introduction/Index.rst @@ -1,4 +1,4 @@ -.. include:: ../Includes.txt +.. include:: ../Includes.rst.txt Introduction ------------ @@ -12,4 +12,3 @@ Cart Events provides an own data storage for events. Events can be offered via a Support/Index Sponsoring/Index - NoteOfThanks/Index diff --git a/Documentation/Introduction/NoteOfThanks/Index.rst b/Documentation/Introduction/NoteOfThanks/Index.rst deleted file mode 100644 index 507ee014..00000000 --- a/Documentation/Introduction/NoteOfThanks/Index.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. include:: ../../Includes.txt - -Note of thanks -============== diff --git a/Documentation/Introduction/Sponsoring/Index.rst b/Documentation/Introduction/Sponsoring/Index.rst index 14f7b7ab..5f4ecdbf 100644 --- a/Documentation/Introduction/Sponsoring/Index.rst +++ b/Documentation/Introduction/Sponsoring/Index.rst @@ -1,5 +1,6 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt +========== Sponsoring ========== @@ -10,7 +11,4 @@ There is also the possibility to support the further development independently o * Ask for an invoice. * `GitHub Sponsors `_ * `PayPal.Me `_ -* `patreon.com `_ -Sponsors --------- diff --git a/Documentation/Introduction/Support/Index.rst b/Documentation/Introduction/Support/Index.rst index eeef55fa..9b1b4221 100644 --- a/Documentation/Introduction/Support/Index.rst +++ b/Documentation/Introduction/Support/Index.rst @@ -1,5 +1,6 @@ -.. include:: ../../Includes.txt +.. include:: ../../Includes.rst.txt +======= Support ======= diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg deleted file mode 100644 index 94e27c06..00000000 --- a/Documentation/Settings.cfg +++ /dev/null @@ -1,21 +0,0 @@ -[general] - -project = Cart Events -version = 5.0 -release = 5.0.0 -t3author = Daniel Gohlke -copyright = 2021-2024 - -description = - -[html_theme_options] - -project_issues = https://github.com/extcode/cart_events/issues -project_repository = https://github.com/extcode/cart_events - -[extlinks] -issue = https://github.com/extcode/cart_events/issues/%s | Issue # - -[intersphinx_mapping] - -t3tsref = https://docs.typo3.org/typo3cms/TyposcriptReference/ diff --git a/Documentation/guides.xml b/Documentation/guides.xml new file mode 100644 index 00000000..dc37459e --- /dev/null +++ b/Documentation/guides.xml @@ -0,0 +1,19 @@ + + + + + +