From 7ac3643a8803f4ed9d1ee75a4fb899290964ea8e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Milo=C5=A1=20Prchl=C3=ADk?= Date: Thu, 18 Jan 2024 11:30:47 +0100 Subject: [PATCH] squash: few tweaks --- docs/Makefile | 28 +++++++++++++++------------- docs/{ => templates}/plugins.rst.j2 | 0 2 files changed, 15 insertions(+), 13 deletions(-) rename docs/{ => templates}/plugins.rst.j2 (100%) diff --git a/docs/Makefile b/docs/Makefile index b4b01d1e51..082e123834 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -53,6 +53,8 @@ TMTDIR = $(REPODIR)/tmt SCRIPTSDIR = scripts TEMPLATESDIR = templates +PLUGINS_TEMPLATE := $(TEMPLATESDIR)/plugins.rst.j2 + generate: spec stories generate-lint-checks generate-plugins generate-stories generate-autodocs ## Refresh all generated documentation sources spec: @@ -64,23 +66,23 @@ stories: 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 $@ -plugins/discover.rst: $(SCRIPTSDIR)/generate-plugins.py plugins.rst.j2 $(TMTDIR)/steps/discover/*.py - $(SCRIPTSDIR)/generate-plugins.py discover plugins.rst.j2 $@ +plugins/discover.rst: $(SCRIPTSDIR)/generate-plugins.py $(PLUGINS_TEMPLATE) $(TMTDIR)/steps/discover/*.py + $(SCRIPTSDIR)/generate-plugins.py discover $(PLUGINS_TEMPLATE) $@ -plugins/execute.rst: $(SCRIPTSDIR)/generate-plugins.py plugins.rst.j2 $(TMTDIR)/steps/execute/*.py - $(SCRIPTSDIR)/generate-plugins.py execute plugins.rst.j2 $@ +plugins/execute.rst: $(SCRIPTSDIR)/generate-plugins.py $(PLUGINS_TEMPLATE) $(TMTDIR)/steps/execute/*.py + $(SCRIPTSDIR)/generate-plugins.py execute $(PLUGINS_TEMPLATE) $@ -plugins/finish.rst: $(SCRIPTSDIR)/generate-plugins.py plugins.rst.j2 $(TMTDIR)/steps/finish/*.py - $(SCRIPTSDIR)/generate-plugins.py finish plugins.rst.j2 $@ +plugins/finish.rst: $(SCRIPTSDIR)/generate-plugins.py $(PLUGINS_TEMPLATE) $(TMTDIR)/steps/finish/*.py + $(SCRIPTSDIR)/generate-plugins.py finish $(PLUGINS_TEMPLATE) $@ -plugins/prepare.rst: $(SCRIPTSDIR)/generate-plugins.py plugins.rst.j2 $(TMTDIR)/steps/prepare/*.py - $(SCRIPTSDIR)/generate-plugins.py prepare plugins.rst.j2 $@ +plugins/prepare.rst: $(SCRIPTSDIR)/generate-plugins.py $(PLUGINS_TEMPLATE) $(TMTDIR)/steps/prepare/*.py + $(SCRIPTSDIR)/generate-plugins.py prepare $(PLUGINS_TEMPLATE) $@ -plugins/provision.rst: $(SCRIPTSDIR)/generate-plugins.py plugins.rst.j2 $(TMTDIR)/steps/provision/*.py - $(SCRIPTSDIR)/generate-plugins.py provision plugins.rst.j2 $@ +plugins/provision.rst: $(SCRIPTSDIR)/generate-plugins.py $(PLUGINS_TEMPLATE) $(TMTDIR)/steps/provision/*.py + $(SCRIPTSDIR)/generate-plugins.py provision $(PLUGINS_TEMPLATE) $@ -plugins/report.rst: $(SCRIPTSDIR)/generate-plugins.py plugins.rst.j2 $(TMTDIR)/steps/report/*.py - $(SCRIPTSDIR)/generate-plugins.py report plugins.rst.j2 $@ +plugins/report.rst: $(SCRIPTSDIR)/generate-plugins.py $(PLUGINS_TEMPLATE) $(TMTDIR)/steps/report/*.py + $(SCRIPTSDIR)/generate-plugins.py report $(PLUGINS_TEMPLATE) $@ plugins/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 $@ @@ -90,7 +92,7 @@ generate-lint-checks: spec spec/lint.rst ## Generate documentation sources for generate-stories: stories $(TEMPLATESDIR)/story.rst.j2 ## Generate documentation sources for stories $(SCRIPTSDIR)/generate-stories.py $(TEMPLATESDIR)/story.rst.j2 -generate-plugins: plugins/discover.rst plugins/execute.rst plugins/finish.rst plugins/prepare.rst plugins/provision.rst plugins/report.rst plugins/test-checks.rst ## Generate documentation sources for plugins +generate-plugins: plugins/*.rst ## Generate documentation sources for plugins generate-autodocs: ## Generate autodocs from source docstrings cd ../ && sphinx-apidoc --force --implicit-namespaces --no-toc -o docs/code/autodocs tmt diff --git a/docs/plugins.rst.j2 b/docs/templates/plugins.rst.j2 similarity index 100% rename from docs/plugins.rst.j2 rename to docs/templates/plugins.rst.j2