From dee89c5266935fefeacda9a6d6e27ec4688d8b83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Uzna=C5=84ski?= Date: Sun, 29 Nov 2020 18:28:34 +0100 Subject: [PATCH] [TASK] Prepare documentation rendering (#157) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Łukasz Uznański --- .gitignore | 1 + .../Documentation/Rendering/Index.rst | 26 ++++++++ Documentation/Includes.txt | 17 +++++ Documentation/Index.rst | 62 +++++++++++++++++ Documentation/Introduction/Index.rst | 16 +++++ Documentation/Settings.cfg | 66 +++++++++++++++++++ Documentation/Sitemap.rst | 9 +++ README.md | 15 +++++ 8 files changed, 212 insertions(+) create mode 100644 Documentation/Documentation/Rendering/Index.rst create mode 100644 Documentation/Includes.txt create mode 100644 Documentation/Index.rst create mode 100644 Documentation/Introduction/Index.rst create mode 100644 Documentation/Settings.cfg create mode 100644 Documentation/Sitemap.rst diff --git a/.gitignore b/.gitignore index 67504f2..a18d28b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ /*.idea /.Build/* /.php_cs.cache +/Documentation-GENERATED-temp/ /Resources/Private/node_modules/ /Resources/Private/package-lock.json /Resources/Private/yarn-error.log diff --git a/Documentation/Documentation/Rendering/Index.rst b/Documentation/Documentation/Rendering/Index.rst new file mode 100644 index 0000000..32db46b --- /dev/null +++ b/Documentation/Documentation/Rendering/Index.rst @@ -0,0 +1,26 @@ +.. include:: ../../Includes.txt + +.. _documentation: + +======================= +Documentation rendering +======================= + +.. _how-to-render-documentation-locally: + +How to render documentation locally? +==================================== + +In order to render documentation, first of all, clone the repository: + +.. code-block:: bash + + git clone https://github.com/TYPO3-Documentation/tea.git + +then go to the extension root: + +.. code-block:: bash + + cd tea + +and follow `the TYPO3 documentation quickstart guide `_ diff --git a/Documentation/Includes.txt b/Documentation/Includes.txt new file mode 100644 index 0000000..b9256d4 --- /dev/null +++ b/Documentation/Includes.txt @@ -0,0 +1,17 @@ +.. ================================================== +.. FOR YOUR INFORMATION +.. -------------------------------------------------- +.. -*- coding: utf-8 -*- with BOM. + +.. This is 'Includes.txt'. It is included at the very top of each and + every ReST source file in THIS documentation project (= manual). + +.. role:: html(code) +.. role:: typoscript(code) +.. role:: ts(typoscript) + :class: typoscript +.. role:: php(code) +.. role:: yaml(code) + +.. default-role:: code +.. highlight:: guess diff --git a/Documentation/Index.rst b/Documentation/Index.rst new file mode 100644 index 0000000..75dcb38 --- /dev/null +++ b/Documentation/Index.rst @@ -0,0 +1,62 @@ +.. include:: Includes.txt + +.. _start: + +============================================================= +EXT:tea +============================================================= + +:Version: + |release| + +:Language: + en + +:Description: + This TYPO3 extension is an example of best practices in continuous integration and automated code checks, also + Extbase/Fluid-based extensions for TYPO3 CMS using PHPUnit, writing unit and functional tests for + extensions for TYPO3 CMS using PHPUnit. + +:Keywords: + tea, ci, continousintegration, gitlab, githubactions, actions, tests, functional, unit + +:Copyright: + 2020 by TYPO3 Association + +:Authors: + * Oliver Klee + +:Email: + typo3-coding@oliverklee.de + +:License: + This extension is published under the + `GNU General Public License v2.0 `__ + +:Rendered: + |today| + +TYPO3 +===== + +The content of this document is related to TYPO3 CMS, +a GNU/GPL CMS/Framework available from `typo3.org `_ . + +For Contributors +================ + +You are welcome to help improve this guide if you missing something. +Just click on "Edit me on GitHub" on the top right to submit your change request +or `report a problem `__ + +Table of Contents +================= + +.. toctree:: + :maxdepth: 3 + :titlesonly: + :glob: + + Introduction/Index + Documentation/Rendering/Index + Sitemap diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst new file mode 100644 index 0000000..0df1e6d --- /dev/null +++ b/Documentation/Introduction/Index.rst @@ -0,0 +1,16 @@ +.. include:: ../Includes.txt + +.. _introduction: + +============== +Introduction +============== + +.. _what-it-does: + +What does it do? +================ + +This TYPO3 extension is an example of best practices in continuous integration and automated code checks, also +writing unit and functional tests with PHPUnit in Extbase/Fluid-based extensions for TYPO3 CMS, and then running them +in a pipeline. diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg new file mode 100644 index 0000000..573c36e --- /dev/null +++ b/Documentation/Settings.cfg @@ -0,0 +1,66 @@ +[general] + +# ................................................................................. +# ... (required) title (displayed in left sidebar (desktop) or top panel (mobile) +# ................................................................................. +project = TYPO3 EXT:tea + +# ................................................................................. +# ... (recommended) version, displayed next to title (desktop) and in