From 0c79910a592be6c8cdea1c68ce1b599de604a8da Mon Sep 17 00:00:00 2001 From: "lina.wolf" Date: Sun, 21 Jan 2024 12:33:37 +0100 Subject: [PATCH] [TASK] Introduce Makefile and command 'make docs' This is more convenient then having to copy-paste the command all the time --- CONTRIBUTING.rst | 13 +++++++++++-- Makefile | 11 +++++++++++ 2 files changed, 22 insertions(+), 2 deletions(-) create mode 100644 Makefile diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b15bd5a9..d97b0b86 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -5,6 +5,15 @@ Contributing Information About Contributing to This Manual ============================================= +Local rendering +--------------- + +You can render this file locally if you have `Docker ` +and `make ` installed on your local +machine:: + + make docs + Create Issues ------------- @@ -21,10 +30,10 @@ Make changes (create pull requests) `rendered page `__, just click on "Edit me on GitHub". * Step-by-step walkthrough of making a change by `Editing Directly on GitHub - `__ + `__ (this requires only a browser) * Step-by-step walkthrough of `Local Editing and Rendering with Docker - `__ + `__ (this requires knowledge of Git and Docker) * See `Writing Documentation `__ for further diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..325b94fd --- /dev/null +++ b/Makefile @@ -0,0 +1,11 @@ +.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