Merge pull request #26 from kbroch-rivosinc/add-src-build-dir

move asciidoc source files to src; build docs in build dir
riscv · Jan 23, 2024 · 5728161 · 5728161
2 parents 930fb52 + a83571b
commit 5728161
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1 @@
-*.pdf
+/build/*
diff --git a/Makefile b/Makefile
@@ -18,9 +18,11 @@ REVMARK ?= Draft
 DOCKER_RUN := docker run --rm -v ${PWD}:/build -w /build \
 riscvintl/riscv-docs-base-container-image:latest
 
-HEADER_SOURCE := header.adoc
-PDF_RESULT := spec-sample.pdf
-HTML_RESULT := spec-sample.html
+SRC_DIR := src
+BUILD_DIR := build
+HEADER_SOURCE := $(SRC_DIR)/header.adoc
+PDF_RESULT := $(BUILD_DIR)/spec-sample.pdf
+HTML_RESULT := $(BUILD_DIR)/spec-sample.html
 
 ASCIIDOCTOR_PDF := asciidoctor-pdf
 ASCIIDOCTOR_HTML := asciidoctor
@@ -65,5 +67,5 @@ build-no-container:
 
 clean:
 	@echo "Cleaning up generated files..."
-	rm -f $(PDF_RESULT) $(HTML_RESULT)
+	rm -rf $(BUILD_DIR)
 	@echo "Cleanup completed."
diff --git a/images/risc-v_logo.png b/images/risc-v_logo.png
diff --git a/readme.adoc b/readme.adoc
@@ -10,7 +10,7 @@ This work is licensed under a Creative Commons Attribution 4.0 International Lic
 
 == Contributors
 
-The list of contributors to this specification is maintained in the link:contributors.adoc[contributors] file.
+The list of contributors to this specification is maintained in the link:src/contributors.adoc[contributors] file.
 
 For guidelines on how to contribute, refer to the link:CONTRIBUTING.md[CONTRIBUTING] file.
 

diff --git a/bibliography.adoc → src/bibliography.adoc b/bibliography.adoc → src/bibliography.adoc
diff --git a/chapter2.adoc → src/chapter2.adoc b/chapter2.adoc → src/chapter2.adoc
diff --git a/contributors.adoc → src/contributors.adoc b/contributors.adoc → src/contributors.adoc
diff --git a/header.adoc → src/header.adoc b/header.adoc → src/header.adoc
@@ -12,13 +12,14 @@ Authors: Author 1, Author 2
 :preface-title: Preamble
 :colophon:
 :appendix-caption: Appendix
-:imagesdir: docs-resources/images
-:title-logo-image: image:risc-v_logo.png[pdfwidth=3.25in,align=center]
+// https://docs.asciidoctor.org/asciidoc/latest/macros/images-directory/
+:imagesdir: ../docs-resources/images
+:title-logo-image: image:risc-v_logo.png["RISC-V International Logo",pdfwidth=3.25in,align=center]
 // Settings:
 :experimental:
 :reproducible:
 //:WaveDromEditorApp: app/wavedrom-editor.app
-:imagesoutdir: docs-resources/images
+:imagesoutdir: ../build/images
 :bibtex-file: example.bib
 :bibtex-order: alphabetical
 :bibtex-style: apa

diff --git a/index.adoc → src/index.adoc b/index.adoc → src/index.adoc
diff --git a/intro.adoc → src/intro.adoc b/intro.adoc → src/intro.adoc