squash: drop it from overview

teemtee · Apr 3, 2024 · 514f642 · 514f642
1 parent 3425a2f
commit 514f642
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 19 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,14 +2,14 @@
 
 /tmp/
 docs/code/autodocs/*.rst
+docs/code/template-filters.rst
 docs/plugins/discover.rst
 docs/plugins/execute.rst
 docs/plugins/finish.rst
 docs/plugins/prepare.rst
 docs/plugins/provision.rst
 docs/plugins/report.rst
 docs/plugins/test-checks.rst
-docs/template-filters.rst
 docs/_build
 docs/spec
 docs/stories

diff --git a/docs/Makefile b/docs/Makefile
@@ -19,7 +19,7 @@ I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 .PHONY: help generate-plugins plugins/*.rst generate-stories generate-template-filters generate-autodocs clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
 
 clean:
-	rm -rf $(BUILDDIR) stories spec code/autodocs/*.rst template-filters.rst
+	rm -rf $(BUILDDIR) stories spec code/autodocs/*.rst code/template-filters.rst
 
 ##
 ## Building documentation
@@ -66,7 +66,7 @@ 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 $@
 
-template-filters.rst: $(SCRIPTSDIR)/generate-template-filters.py $(TEMPLATESDIR)/template-filters.rst.j2 $(TMTDIR)/utils.py
+code/template-filters.rst: $(SCRIPTSDIR)/generate-template-filters.py $(TEMPLATESDIR)/template-filters.rst.j2 $(TMTDIR)/utils.py
 	$(SCRIPTSDIR)/generate-template-filters.py $(TEMPLATESDIR)/template-filters.rst.j2 $@
 
 plugins/discover.rst: $(SCRIPTSDIR)/generate-plugins.py $(PLUGINS_TEMPLATE) $(TMTDIR)/steps/discover/*.py
@@ -92,7 +92,7 @@ plugins/test-checks.rst: $(SCRIPTSDIR)/generate-plugins.py $(PLUGINS_TEMPLATE) $
 
 generate-lint-checks: spec spec/lint.rst  ## Generate documentation sources for lint checks
 
-generate-template-filters: template-filters.rst  ## Generate documentation sources for Jinja2 template filters
+generate-template-filters: code/template-filters.rst  ## Generate documentation sources for Jinja2 template filters
 
 generate-stories: stories $(TEMPLATESDIR)/story.rst.j2  ## Generate documentation sources for stories
 	$(SCRIPTSDIR)/generate-stories.py $(TEMPLATESDIR)/story.rst.j2

diff --git a/docs/code/index.rst b/docs/code/index.rst
@@ -13,6 +13,7 @@ the documentation generated from sources linked below.
 .. toctree::
     :maxdepth: 2
 
+    Template Filters <template-filters>
     Class Overview <classes>
     Plugin Introduction <plugin-introduction>
     tmt <autodocs/tmt>

diff --git a/docs/overview.rst b/docs/overview.rst
@@ -662,8 +662,6 @@ __ https://docs.python.org/3.9/library/re.html#regular-expression-syntax
 __ https://docs.python.org/3.9/howto/regex.html#regex-howto
 
 
-.. include:: template-filters.rst
-
 Links
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -176,18 +176,13 @@ dependencies = ["tmt[docs]"]
 [tool.hatch.envs.docs.scripts]
 html = "make -C {root}/docs html"
 man = [
-    "make -C docs generate-template-filters",
-    "mkdir -p {root}/docs/_build/man/",
-    "cp {root}/docs/header.txt {root}/docs/_build/man/man.rst",
-    "cp {root}/docs/template-filters.rst {root}/docs/_build/man/",
-    "tail -n+8 {root}/docs/overview.rst >> {root}/docs/_build/man/man.rst",
-    # TODO rst2man cannot process these directives
-    "sed -i '/versionadded::/d'                                  {root}/docs/_build/man/man.rst",
-    "sed -i 's/:ref:`regular-expressions`/regular expressions/g' {root}/docs/_build/man/template-filters.rst",
-    "sed -i 's/:ref:`custom_templates`/custom templates/g'       {root}/docs/_build/man/template-filters.rst",
-    "rst2man.py {root}/docs/_build/man/man.rst > {root}/docs/_build/man/tmt.1",
-    "cp {root}/docs/_build/man/tmt.1 {root}/tmt.1"
-    ]
+    "cp {root}/docs/header.txt {root}/man.rst",
+    "tail -n+8 docs/overview.rst >> {root}/man.rst",
+    # TODO rst2man cannot process this directive, removed for now
+    "sed '/versionadded::/d' -i {root}/man.rst",
+    "rst2man.py {root}/man.rst > {root}/tmt.1",
+    "rm -f {root}/man.rst",
+]
 
 [dirs.env]
 virtual = ".venv"

diff --git a/tmt.spec b/tmt.spec
@@ -8,7 +8,6 @@ URL:            https://github.com/teemtee/tmt
 Source0:        %{pypi_source tmt}
 
 BuildArch:      noarch
-BuildRequires:  make
 BuildRequires:  python3-devel
 
 Requires:       git-core rsync sshpass
-Original file line number
+Diff line change
@@ Expand Up @@
     __ https://docs.python.org/3.9/howto/regex.html#regex-howto
-    .. include:: template-filters.rst
     Links
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ Expand Down @@