diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 000000000..79ac662ea --- /dev/null +++ b/.github/workflows/documentation.yml @@ -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 diff --git a/Documentation/ForAdministrators/Templates/Changing/Index.rst b/Documentation/ForAdministrators/Templates/Changing/Index.rst index b4251021d..a19357508 100644 --- a/Documentation/ForAdministrators/Templates/Changing/Index.rst +++ b/Documentation/ForAdministrators/Templates/Changing/Index.rst @@ -50,4 +50,4 @@ now required to use TSConfig:: templates.derhansen/sf_event_mgt.20 = derhansen/sf_event_mgt_extend_demo:Resources/Private -Details see :doc:`changelog entry` +Details see :ref:`changelog entry ` diff --git a/Documentation/Includes.rst.txt b/Documentation/Includes.rst.txt index fe320f637..b5b5ca986 100644 --- a/Documentation/Includes.rst.txt +++ b/Documentation/Includes.rst.txt @@ -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 diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 6b4182caf..2284b7dc7 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -137,25 +137,18 @@ TYPO3 CMS. .. container:: card-body Various extensions improve ext:sf_event_mgt with additional features. -.. Table of Contents - -.. toctree:: - :maxdepth: 5 - :titlesonly: - :hidden: - - Introduction/Index - ForEditors/Index - ForAdministrators/Index - ForDevelopers/Index - Faq/Index - Reference/Index - Miscellaneous/Index -.. Meta Menu - -.. toctree:: - :hidden: +.. Table of Contents - Sitemap - genindex +.. toctree:: + :maxdepth: 5 + :titlesonly: + :hidden: + + Introduction/Index + ForEditors/Index + ForAdministrators/Index + ForDevelopers/Index + Faq/Index + Reference/Index + Addons/Index diff --git a/Documentation/Reference/MigrationFromSeminars/Index.rst b/Documentation/Reference/MigrationFromSeminars/Index.rst index 09128b7ba..b9c9a0b7b 100644 --- a/Documentation/Reference/MigrationFromSeminars/Index.rst +++ b/Documentation/Reference/MigrationFromSeminars/Index.rst @@ -30,7 +30,7 @@ SQL queries We are starting with a fresh install of sf_event_mgt so we can use ids mostly 1 to 1. -.. code-block:: mysql +.. code-block:: sql /* Organizers */ INSERT INTO tx_sfeventmgt_domain_model_organisator (uid,pid,name,email,email_signature) diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg deleted file mode 100644 index 4ec798145..000000000 --- a/Documentation/Settings.cfg +++ /dev/null @@ -1,73 +0,0 @@ -# coding: utf-8 - -# ##### -# -# Settings.cfg - A TYPO3 Documentation Project's Configuration File -# Information about Settings.cfg: -# https://docs.typo3.org/typo3cms/HowToDocument/GeneralConventions/DirectoryFilenames.html#settings-cfg -# -# About Syntax: -# See https://docs.python.org/2/library/configparser.html -# -# Attention: -# Only " ;" can start an inline comment. -# This is: blank PLUS semicolon! -# -# ##### - -[general] - -project = Event management and registration -version = 7.0 -release = 7.2.0 -t3author = Torben Hansen -copyright = 2014 - 2023 by Torben Hansen - -description = Official documentation for the TYPO3 Extension "Event management and registration" - -[html_theme_options] - -; for theme t3SphinxThemeRtd - -#### NOTE: Fill in YOUR values in the following! - -github_branch = master -github_repository = derhansen/sf_event_mgt - -# usually an email address -project_contact = mailto:torben@derhansen.com - -# URL of online discussions, you can leave this blank -project_discussions = - -# URL of webpage of your extension (if it has one) -project_home = https://github.com/derhansen/sf_event_mgt - -# URL to Issues -project_issues = https://github.com/derhansen/sf_event_mgt/issues - -# URL of repository -project_repository = https://github.com/derhansen/sf_event_mgt - -# just leave this blank -use_opensearch = - - -[intersphinx_mapping] - -; Comment out what you don't use. -; Uncomment only what you actually use in crossreferencing! - -# h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/ -t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ -# t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/master/en-us/ -# t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/master/en-us/Index.html -# t3install = https://docs.typo3.org/m/typo3/guide-installation/master/en-us/ -# t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/master/en-us/ -# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/master/en-us/ -# t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/master/en-us/ -# t3tca = https://docs.typo3.org/m/typo3/reference-tca/master/en-us/ -# t3templating = https://docs.typo3.org/m/typo3/tutorial-templating-with-fluid/master/en-us/ -# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/master/en-us/ -# t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/master/en-us/ -# t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/ diff --git a/Documentation/guides.xml b/Documentation/guides.xml new file mode 100644 index 000000000..234b96e67 --- /dev/null +++ b/Documentation/guides.xml @@ -0,0 +1,18 @@ + + + + + diff --git a/Makefile b/Makefile new file mode 100644 index 000000000..e48420894 --- /dev/null +++ b/Makefile @@ -0,0 +1,16 @@ +.PHONY: help +help: ## Displays this list of targets with descriptions + @echo "The following commands are available:\n" + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' + +.PHONY: docs +docs: ## Generate projects docs (from "Documentation" directory) + mkdir -p Documentation-GENERATED-temp + + docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation + +.PHONY: test-docs +test-docs: ## Test the documentation rendering + mkdir -p Documentation-GENERATED-temp + + docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log