action #110181
closedci:build-docs broken and not clear how to use tools/generate-documentation
Description
+ /home/squamata/project/.gem/bin/asciidoctor.ruby2.5 -r asciidoctor-pdf -b pdf -o /tmp/openqa-doc-WVtp/output/openqa-documentation-20220421_d2c43c797.pdf index.asciidoc -d book
asciidoctor: WARNING: Installing.asciidoc: line 1039: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Installing.asciidoc: line 1047: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Installing.asciidoc: line 1122: list item index: expected 7, got 5
asciidoctor: WARNING: Installing.asciidoc: line 1131: list item index: expected 8, got 6
asciidoctor: WARNING: Installing.asciidoc: line 1150: list item index: expected 9, got 7
asciidoctor: WARNING: Installing.asciidoc: line 1157: list item index: expected 10, got 8
asciidoctor: WARNING: Installing.asciidoc: line 1168: list item index: expected 11, got 9
asciidoctor: WARNING: Installing.asciidoc: line 1175: list item index: expected 12, got 10
asciidoctor: WARNING: Installing.asciidoc: line 1182: list item index: expected 13, got 11
asciidoctor: WARNING: Contributing.asciidoc: line 418: list item index: expected 3, got 2
asciidoctor: WARNING: Contributing.asciidoc: line 420: list item index: expected 4, got 3
asciidoctor: WARNING: Contributing.asciidoc: line 423: list item index: expected 5, got 4
asciidoctor: WARNING: Contributing.asciidoc: line 424: list item index: expected 6, got 5
asciidoctor: ERROR: could not locate or load the built-in pdf theme `' because of ArgumentError unknown keywords: aliases, filename; reverting to default theme
unknown keywords: aliases, filename
Use --trace to show backtrace
Seems like asciidoctor just got a little bit stricter.
But also I am not able to call tools/generate-documentation locally:
a1a8237309549fe7033da1cd724ce100f6846f65 refs/heads/gh-pages
asciidoctor: FAILED: 'asciidoctor-pdf' could not be loaded
Use --trace for backtrace
I think we should have a command that runs a container generating the docs instead of having to install several packages with gem, cpanm and so on.
Alternatively we could simply suggest to call
asciidoctor -o openqa.html docs/index.asciidoc -d book
instead of tools/generate-documentation in .github/checklist.yml.
Updated by tinita over 2 years ago
- Description updated (diff)
- Status changed from New to In Progress
- Assignee set to tinita
Updated by okurz over 2 years ago
tinita wrote:
[…]
But also I am not able to call tools/generate-documentation locally:a1a8237309549fe7033da1cd724ce100f6846f65 refs/heads/gh-pages asciidoctor: FAILED: 'asciidoctor-pdf' could not be loaded Use --trace for backtrace
I can reproduce that
I think we should have a command that runs a container generating the docs instead of having to install several packages with
gem,cpanmand so on.
We already have a container setup for executing tests. That one should provide all necessary dependencies for building documentation as well, see http://open.qa/docs/#_run_tests_within_a_container
Updated by tinita over 2 years ago
We already have a container setup for executing tests. That one should provide all necessary dependencies for building documentation as well, see http://open.qa/docs/#_run_tests_within_a_container
Yes, I am trying that container now.
At least we should have an easy command to execute in .github/checklist.yml
What it currently says simply doesn't work.
Updated by tinita over 2 years ago
- Priority changed from High to Normal
https://github.com/os-autoinst/openQA/pull/4616 Fix documentation
edit: merged
Updated by tinita over 2 years ago
As Jan mentioned:
On the compliance front, Asciidoctor PDF 2 will require Ruby 2.7 and JRuby 9.2 at a minimum
So we should at some point either:
- Upgrade ruby or
- pin to an older version of asciidoctor(-pdf)
Updated by openqa_review over 2 years ago
- Due date set to 2022-05-06
Setting due date based on mean cycle time of SUSE QE Tools
Updated by tinita over 2 years ago
https://github.com/os-autoinst/openQA/pull/4619 - Pin asciidoctor-pdf to a Ruby 2.5 compatible version #4619
edit: merged
Updated by tinita over 2 years ago
- Status changed from In Progress to Feedback
https://github.com/os-autoinst/openQA/pull/4623 Add simple command to generate HTML documentation (merged)
Updated by jbaier_cz almost 2 years ago
- Related to action #122584: build-docs-nightly fails with "Error installing asciidoctor-pdf" size:M added