Move docs templates into their own directory

Let's keep `docs/` clean.
teemtee · Jan 5, 2024 · 5744040 · 5744040
1 parent 92615d7
commit 5744040
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 6 deletions.
diff --git 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 → docs/templates/lint-checks.rst.j2 b/docs/lint-checks.rst.j2 → docs/templates/lint-checks.rst.j2
diff --git a/docs/story.rst.j2 → docs/templates/story.rst.j2 b/docs/story.rst.j2 → docs/templates/story.rst.j2
diff --git a/docs/test-checks.rst.j2 → docs/templates/test-checks.rst.j2 b/docs/test-checks.rst.j2 → docs/templates/test-checks.rst.j2