move images and add makefile

2024-11-21 14:22:33 +00:00 · 2024-05-18 10:22:33 +02:00 · 2024-05-18 10:22:33 +02:00 · 2991099daa
commit 2991099daa
parent 739e5861c2
9 changed files with 11 additions and 21 deletions
--- a/docs/Makefile
+++ 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
--- 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`.
--- a/docs/modules/ROOT/images/bootloader_flash.png
+++ b/docs/modules/ROOT/images/bootloader_flash.png
--- a/docs/modules/ROOT/images/embassy_executor.drawio
+++ b/docs/modules/ROOT/images/embassy_executor.drawio
--- a/docs/modules/ROOT/images/embassy_executor.png
+++ b/docs/modules/ROOT/images/embassy_executor.png
--- a/docs/modules/ROOT/images/embassy_irq.drawio
+++ b/docs/modules/ROOT/images/embassy_irq.drawio
--- a/docs/modules/ROOT/images/embassy_irq.png
+++ b/docs/modules/ROOT/images/embassy_irq.png
--- a/docs/index.adoc
+++ b/docs/index.adoc
@ -4,6 +4,7 @@
 :toc:
 :toc-placement: left
 :toclevels: 2
+:imagesdir: images

 # Embassy Book

--- a/docs/modules/ROOT/nav.adoc
+++ b/docs/modules/ROOT/nav.adoc
@ -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]