From 2991099daa5b1cfbc7b67f358497ec4821c71a53 Mon Sep 17 00:00:00 2001
From: Ulf Lilleengen <ulf.lilleengen@gmail.com>
Date: Sat, 18 May 2024 10:22:33 +0200
Subject: [PATCH] move images and add makefile
---
docs/Makefile | 8 ++++++++
docs/README.md | 4 ++--
.../ROOT => }/images/bootloader_flash.png | Bin
.../ROOT => }/images/embassy_executor.drawio | 0
.../ROOT => }/images/embassy_executor.png | Bin
.../ROOT => }/images/embassy_irq.drawio | 0
.../{modules/ROOT => }/images/embassy_irq.png | Bin
docs/index.adoc | 1 +
docs/modules/ROOT/nav.adoc | 19 ------------------
9 files changed, 11 insertions(+), 21 deletions(-)
create mode 100644 docs/Makefile
rename docs/{modules/ROOT => }/images/bootloader_flash.png (100%)
rename docs/{modules/ROOT => }/images/embassy_executor.drawio (100%)
rename docs/{modules/ROOT => }/images/embassy_executor.png (100%)
rename docs/{modules/ROOT => }/images/embassy_irq.drawio (100%)
rename docs/{modules/ROOT => }/images/embassy_irq.png (100%)
delete mode 100644 docs/modules/ROOT/nav.adoc
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 000000000..eadcf2370
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,8 @@
+all:
+ asciidoctor -d book -D thebook/ index.adoc
+ cp -r images thebook
+
+clean:
+ rm -rf thebook
+
+.PHONY: all clean
diff --git a/docs/README.md b/docs/README.md
index 8b9a3c48d..94ebd7a05 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,9 +1,9 @@
# embassy docs
-The documentation hosted at [https://embassy.dev/book](https://embassy.dev/book). Building the documentation requires the [asciidoctor](https://asciidoctor.org/) tool, and can be built like this:
+The documentation hosted at [https://embassy.dev/book](https://embassy.dev/book). Building the documentation requires the [asciidoctor](https://asciidoctor.org/) tool, and can built running `make` in this folder:
```
-asciidoctor -d book -D thebook/ index.adoc
+make
```
Then open the generated file `thebook/index.html`.
diff --git a/docs/modules/ROOT/images/bootloader_flash.png b/docs/images/bootloader_flash.png
similarity index 100%
rename from docs/modules/ROOT/images/bootloader_flash.png
rename to docs/images/bootloader_flash.png
diff --git a/docs/modules/ROOT/images/embassy_executor.drawio b/docs/images/embassy_executor.drawio
similarity index 100%
rename from docs/modules/ROOT/images/embassy_executor.drawio
rename to docs/images/embassy_executor.drawio
diff --git a/docs/modules/ROOT/images/embassy_executor.png b/docs/images/embassy_executor.png
similarity index 100%
rename from docs/modules/ROOT/images/embassy_executor.png
rename to docs/images/embassy_executor.png
diff --git a/docs/modules/ROOT/images/embassy_irq.drawio b/docs/images/embassy_irq.drawio
similarity index 100%
rename from docs/modules/ROOT/images/embassy_irq.drawio
rename to docs/images/embassy_irq.drawio
diff --git a/docs/modules/ROOT/images/embassy_irq.png b/docs/images/embassy_irq.png
similarity index 100%
rename from docs/modules/ROOT/images/embassy_irq.png
rename to docs/images/embassy_irq.png
diff --git a/docs/index.adoc b/docs/index.adoc
index f0fa6f2b7..9c6150196 100644
--- a/docs/index.adoc
+++ b/docs/index.adoc
@@ -4,6 +4,7 @@
:toc:
:toc-placement: left
:toclevels: 2
+:imagesdir: images
# Embassy Book
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
deleted file mode 100644
index 44b0eddb9..000000000
--- a/docs/modules/ROOT/nav.adoc
+++ /dev/null
@@ -1,19 +0,0 @@
-* xref:getting_started.adoc[Getting started]
-** xref:basic_application.adoc[Basic application]
-** xref:project_structure.adoc[Project Structure]
-** xref:new_project.adoc[Starting a new Embassy project]
-** xref:best_practices.adoc[Best Practices]
-* xref:runtime.adoc[Executor]
-* xref::time_keeping.adoc[Time-keeping]
-* xref:sharing_peripherals.adoc[Sharing peripherals]
-* xref:hal.adoc[HAL]
-** xref:layer_by_layer.adoc[Anatomy of an async HAL]
-** xref:nrf.adoc[nRF]
-** xref:stm32.adoc[STM32]
-* xref:bootloader.adoc[Bootloader]
-
-* xref:examples.adoc[Examples]
-* xref:developer.adoc[Developer Docs]
-** xref:developer_stm32.adoc[Developer Docs: STM32]
-* xref:embassy_in_the_wild.adoc[Embassy in the wild]
-* xref:faq.adoc[Frequently Asked Questions]