forked from os-autoinst/openQA
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add simple command to generate HTML documentation
tools/generate-htmldoc will generate the HTML documentation in a container and write it to openqa-documentation.html The checklist suggestes to run this command to check if any asciidoc changes are looking good, instead of the previous non functioning tools/generate-documentation suggestion. Issue: https://progress.opensuse.org/issues/110181
- Loading branch information
Showing
4 changed files
with
15 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -45,3 +45,4 @@ job.json | |
node_modules | ||
package-lock.json | ||
.tidyall.d/ | ||
openqa-documentation.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |