From d492bbe74a2b4c75b692ddae405976155565ead6 Mon Sep 17 00:00:00 2001 From: "lina.wolf" Date: Sat, 17 Feb 2024 14:50:36 +0100 Subject: [PATCH] [DOCS] Fix warnings, create makefile for easy doc rendering --- .github/CONTRIBUTING.md | 11 +++++++++++ Documentation/Index.rst | 2 -- Documentation/Misc/Changelog/11-4-0.rst | 1 - Documentation/Misc/Changelog/11-4-1.rst | 1 - .../Reference/ViewHelpers/RenderMediaViewHelper.rst | 1 - Makefile | 10 ++++++++++ 6 files changed, 21 insertions(+), 5 deletions(-) create mode 100644 Makefile diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a833e78364..0c7b06b516 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -40,6 +40,17 @@ email, or any other method with the owners of this repository before making a ch For changes of a trivial nature, it is not always necessary to create a new issue. +## Render the documentation locally + +To render the documentation locally you can use the following `make` command: + +``` + make docs +``` + +If `make` is not available on your machine you can also call the commands provided +in the file `Makefile` manually. + ## Additional resources * [Rendered documentation](https://docs.typo3.org/p/georgringer/news/main/en-us/) diff --git a/Documentation/Index.rst b/Documentation/Index.rst index ea2c519a05..8a7285641c 100755 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -1,5 +1,3 @@ -.. include:: /Includes.rst.txt - .. _start: =========== diff --git a/Documentation/Misc/Changelog/11-4-0.rst b/Documentation/Misc/Changelog/11-4-0.rst index 81820ea97b..608eb35118 100644 --- a/Documentation/Misc/Changelog/11-4-0.rst +++ b/Documentation/Misc/Changelog/11-4-0.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt 11.4.0 - 8th February 2024 ========================== diff --git a/Documentation/Misc/Changelog/11-4-1.rst b/Documentation/Misc/Changelog/11-4-1.rst index d51fea4131..8ce4bd0e27 100644 --- a/Documentation/Misc/Changelog/11-4-1.rst +++ b/Documentation/Misc/Changelog/11-4-1.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt 11.4.1 - 8th February 2024 ========================== diff --git a/Documentation/Reference/ViewHelpers/RenderMediaViewHelper.rst b/Documentation/Reference/ViewHelpers/RenderMediaViewHelper.rst index 437c8190c5..86bb83a075 100644 --- a/Documentation/Reference/ViewHelpers/RenderMediaViewHelper.rst +++ b/Documentation/Reference/ViewHelpers/RenderMediaViewHelper.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _viewHelperRenderMedia: diff --git a/Makefile b/Makefile new file mode 100644 index 0000000000..97039388cc --- /dev/null +++ b/Makefile @@ -0,0 +1,10 @@ +.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