Update build-pdf.yml #198
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
| # Makefile for RISC-V Doc Template | ||
| # | ||
| # This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 | ||
| # International License. To view a copy of this license, visit | ||
| # http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to | ||
| # Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. | ||
| # | ||
| # SPDX-License-Identifier: CC-BY-SA-4.0 | ||
| # | ||
| # Description: | ||
| # | ||
| # This Makefile is designed to automate the process of building and packaging | ||
| # the Doc Template for RISC-V Extensions. | ||
| DOCS := \ | ||
| docs-dev-guide.adoc | ||
| DATE ?= $(shell date +%Y-%m-%d) | ||
| VERSION ?= v0.0.0 | ||
| REVMARK ?= Draft | ||
| ifneq ($(SKIP_DOCKER),true) | ||
| DOCKER_CMD := docker run --rm -v ${PWD}:/build -w /build \ | ||
| riscvintl/riscv-docs-base-container-image:latest \ | ||
| /bin/sh -c | ||
| DOCKER_QUOTE := " | ||
| endif | ||
| SRC_DIR := src | ||
| BUILD_DIR := build | ||
| DOCS_PDF := $(DOCS:%.adoc=%.pdf) | ||
| DOCS_HTML := $(DOCS:%.adoc=%.html) | ||
| XTRA_ADOC_OPTS := | ||
| ASCIIDOCTOR_PDF := asciidoctor-pdf | ||
| ASCIIDOCTOR_HTML := asciidoctor | ||
| OPTIONS := --trace \ | ||
| -a compress \ | ||
| -a mathematical-format=svg \ | ||
| -a pdf-fontsdir=docs-resources/fonts \ | ||
| -a pdf-theme=docs-resources/themes/riscv-pdf.yml \ | ||
| $(XTRA_ADOC_OPTS) \ | ||
| -D build \ | ||
| --failure-level=ERROR | ||
| REQUIRES := --require=asciidoctor-diagram \ | ||
| --require=asciidoctor-mathematical | ||
| .PHONY: all build clean build-container build-no-containee | ||
| all: build | ||
| build-docs: $(DOCS_PDF) $(DOCS_HTML) | ||
| vpath %.adoc $(SRC_DIR) | ||
| %.pdf: %.adoc | ||
| $(DOCKER_CMD) $(DOCKER_QUOTE) $(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) $< $(DOCKER_QUOTE) | ||
| %.html: %.adoc | ||
| $(DOCKER_CMD) $(DOCKER_QUOTE) $(ASCIIDOCTOR_HTML) $(OPTIONS) $(REQUIRES) $< $(DOCKER_QUOTE) | ||
| build: | ||
| @echo "Checking if Docker is available..." | ||
| @if command -v docker >/dev/null 2>&1 ; then \ | ||
| echo "Docker is available, building inside Docker container..."; \ | ||
| $(MAKE) build-container; \ | ||
| else \ | ||
| echo "Docker is not available, building without Docker..."; \ | ||
| $(MAKE) build-no-container; \ | ||
| fi | ||
| build-container: | ||
| @echo "Starting build inside Docker container..." | ||
| $(MAKE) build-docs | ||
| @echo "Build completed successfully inside Docker container." | ||
| build-no-container: | ||
| @echo "Starting build..." | ||
| $(MAKE) SKIP_DOCKER=true build-docs | ||
| @echo "Build completed successfully." | ||
| clean: | ||
| @echo "Cleaning up generated files..." | ||
| rm -rf $(BUILD_DIR) | ||
| @echo "Cleanup completed." | ||
