Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions .github/workflows/build-booklet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,23 +30,19 @@ concurrency:
jobs:
build:
runs-on: ubuntu-latest
# Pandoc and the XeLaTeX tool chain come with the container image.
container: gabrielfrasantos/embedded-devcontainer-documentation:v7.4.0@sha256:0537b16931e116f98fd62e0bad454af5bcd102ec6501ccdef2b270aa83fd281e
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0

- uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
with:
python-version: "3.12"

- name: Install Pandoc and TeX toolchain
run: |
sudo apt-get update
sudo apt-get install -y --no-install-recommends \
pandoc texlive-xetex texlive-latex-extra texlive-fonts-recommended lmodern librsvg2-bin
# The checkout belongs to the runner user, while the container runs as root.
- name: Mark the workspace as a safe Git directory
run: git config --global --add safe.directory "${GITHUB_WORKSPACE}"

- name: Build booklet (PDF + HTML)
run: python scripts/build-booklet.py --format all
run: python3 scripts/build-booklet.py --format all

- name: Upload PDF artifact
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The entire documentation set is also published as a single book — read it onli
PDF from the [Releases page](https://github.com/embedded-pro/robotics-toolbox-cpp/releases/latest). Both are generated automatically from `doc/`
(cover, Summary/table of contents, one chapter per category, consolidated references, back cover).

Build it locally with [Pandoc](https://pandoc.org) + XeLaTeX installed:
Build it locally with [Pandoc](https://pandoc.org) + XeLaTeX installed, or in the [`embedded-devcontainer-documentation`](https://hub.docker.com/r/gabrielfrasantos/embedded-devcontainer-documentation) container image that CI uses:

```bash
python scripts/build-booklet.py --format all # writes build/booklet/{RoboticsToolbox.pdf,index.html}
Expand Down
Loading