Skip to content

Commit

Permalink
Added support for EPUB builds
Browse files Browse the repository at this point in the history
This pull requests adds `asciidoctor-epub3` as a Ruby package to be
installed to support EPUB builds. It also updates the documentation to
address an issue with EPUB CSS decoding: SASS (asciidoctor-epub3 dependency)
relies on the environment encoding when decoding CSS files.

Signed-off-by: Ioan-Cristian CÎRSTEA <ioan-cristian.cirstea@tutanota.com>
  • Loading branch information
Ioan-Cristian CÎRSTEA committed May 12, 2024
1 parent ac1954b commit d458d75
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
1 change: 1 addition & 0 deletions Dockerfiles/ubuntu2204
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ RUN export DEBIAN_FRONTEND=noninteractive && \
asciidoctor-lists \
asciidoctor-mathematical \
asciidoctor-pdf \
asciidoctor-epub3 \
asciidoctor-kroki \
citeproc-ruby \
coderay \
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ To build the documentation, execute the following steps:
# clone the upstream repository of the documentation (see The Branches)
# run the build within the container from within the riscv-isa-manual directory
docker run -it -v $(pwd)/riscv-isa-manual:/build riscvintl/riscv-docs-base-container-image:latest /bin/sh -c 'cd ./build; make'
docker run -it -v $(pwd)/riscv-isa-manual:/build riscvintl/riscv-docs-base-container-image:latest /bin/sh -c 'EXPORT LANG=C.utf8; cd ./build; make'
```

The build artifacts will be located within the `riscv-isa-manual` in the `build` directory, for instance:
Expand Down Expand Up @@ -118,6 +118,8 @@ To build the documentation, execute the following steps:
docker run -it -v $(pwd)/riscv-isa-manual:/build riscvintl/riscv-docs-base-container-image:latest /bin/bash
# within the container
# asciidoctor-epub3's dependency SASS fails to parse SCSS files due to the encoding being set to ANSI_X3.4-1968
export LANG=C.utf8
cd ./build
make
```
Expand Down

0 comments on commit d458d75

Please sign in to comment.