Merge pull request #4623 from perlpunk/gendoc

Add simple command to generate HTML documentation

.github/checklist.yml

@@ -4,4 +4,4 @@ paths:
   "assets/stylesheets/**":
     - Consider providing screenshots in a PR comment to show the difference visually
   "docs/*.asciidoc":
-    - Consider generating documentation locally to verify it is rendered correctly using `tools/generate-documentation`
+    - Consider generating documentation locally to verify it is rendered correctly using `tools/generate-htmldoc`

.gitignore

@@ -45,3 +45,4 @@ job.json
 node_modules
 package-lock.json
 .tidyall.d/
+openqa-documentation.html

tools/generate-htmldoc

@@ -0,0 +1,4 @@
+#!/bin/bash -e
+
+cre=${cre:-"podman"}
+$cre run -it --rm -v"$PWD"/:/openqa --workdir /openqa --env GEM_HOME=/home/squamata/.gem registry.opensuse.org/devel/openqa/ci/containers/base:latest tools/generate-htmldoc-in-container

tools/generate-htmldoc-in-container

@@ -0,0 +1,9 @@
+#!/bin/bash -e
+
+gem install asciidoctor pygments.rb
+
+asciidoctor_bin=$(command -v asciidoctor) || true
+[[ -n "$asciidoctor_bin" ]] || \
+    for asciidoctor_bin in "${GEM_HOME}"/bin/asciidoctor.ruby*; do :; done
+set -x
+"$asciidoctor_bin" -o openqa-documentation.html docs/index.asciidoc -d book