From 5744040ff96d25083ffab7ba9a3ecae8c0701248 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Milo=C5=A1=20Prchl=C3=ADk?= Date: Mon, 4 Dec 2023 09:24:53 +0100 Subject: [PATCH] Move docs templates into their own directory Let's keep `docs/` clean. --- docs/Makefile | 13 +++++++------ docs/{ => templates}/lint-checks.rst.j2 | 0 docs/{ => templates}/story.rst.j2 | 0 docs/{ => templates}/test-checks.rst.j2 | 0 4 files changed, 7 insertions(+), 6 deletions(-) rename docs/{ => templates}/lint-checks.rst.j2 (100%) rename docs/{ => templates}/story.rst.j2 (100%) rename docs/{ => templates}/test-checks.rst.j2 (100%) diff --git a/docs/Makefile b/docs/Makefile index 82b7929753..50187015e5 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -51,6 +51,7 @@ man: generate ## Make manual pages REPODIR = .. TMTDIR = $(REPODIR)/tmt SCRIPTSDIR = scripts +TEMPLATESDIR = templates generate: spec stories generate-lint-checks generate-test-checks generate-stories generate-autodocs ## Refresh all generated documentation sources @@ -60,16 +61,16 @@ spec: stories: mkdir -p stories -spec/lint.rst: $(SCRIPTSDIR)/generate-lint-checks.py lint-checks.rst.j2 $(TMTDIR)/base.py - $(SCRIPTSDIR)/generate-lint-checks.py lint-checks.rst.j2 $@ +spec/lint.rst: $(SCRIPTSDIR)/generate-lint-checks.py $(TEMPLATESDIR)/lint-checks.rst.j2 $(TMTDIR)/base.py + $(SCRIPTSDIR)/generate-lint-checks.py $(TEMPLATESDIR)/lint-checks.rst.j2 $@ -spec/test-checks.rst: $(SCRIPTSDIR)/generate-test-checks.py test-checks.rst.j2 $(TMTDIR)/checks/*.py - $(SCRIPTSDIR)/generate-test-checks.py test-checks.rst.j2 $@ +spec/test-checks.rst: $(SCRIPTSDIR)/generate-test-checks.py $(TEMPLATESDIR)/test-checks.rst.j2 $(TMTDIR)/checks/*.py + $(SCRIPTSDIR)/generate-test-checks.py $(TEMPLATESDIR)/test-checks.rst.j2 $@ generate-lint-checks: spec spec/lint.rst ## Generate documentation sources for lint checks -generate-stories: stories ## Generate documentation sources for stories - $(SCRIPTSDIR)/generate-stories.py story.rst.j2 +generate-stories: stories $(TEMPLATESDIR)/story.rst.j2 ## Generate documentation sources for stories + $(SCRIPTSDIR)/generate-stories.py $(TEMPLATESDIR)/story.rst.j2 generate-test-checks: spec spec/test-checks.rst ## Generate documentation sources for test checks diff --git a/docs/lint-checks.rst.j2 b/docs/templates/lint-checks.rst.j2 similarity index 100% rename from docs/lint-checks.rst.j2 rename to docs/templates/lint-checks.rst.j2 diff --git a/docs/story.rst.j2 b/docs/templates/story.rst.j2 similarity index 100% rename from docs/story.rst.j2 rename to docs/templates/story.rst.j2 diff --git a/docs/test-checks.rst.j2 b/docs/templates/test-checks.rst.j2 similarity index 100% rename from docs/test-checks.rst.j2 rename to docs/templates/test-checks.rst.j2