aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorUlf Lilleengen <[email protected]>2024-05-18 10:22:33 +0200
committerUlf Lilleengen <[email protected]>2024-05-21 10:05:21 +0200
commit2991099daa5b1cfbc7b67f358497ec4821c71a53 (patch)
tree979ca89f6580365fcff0f6c65587480cdf7d9cd6 /docs
parent739e5861c2e47db251725163fcd91cd822cf97b7 (diff)
move images and add makefile
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile8
-rw-r--r--docs/README.md4
-rw-r--r--docs/images/bootloader_flash.png (renamed from docs/modules/ROOT/images/bootloader_flash.png)bin32147 -> 32147 bytes
-rw-r--r--docs/images/embassy_executor.drawio (renamed from docs/modules/ROOT/images/embassy_executor.drawio)0
-rw-r--r--docs/images/embassy_executor.png (renamed from docs/modules/ROOT/images/embassy_executor.png)bin121382 -> 121382 bytes
-rw-r--r--docs/images/embassy_irq.drawio (renamed from docs/modules/ROOT/images/embassy_irq.drawio)0
-rw-r--r--docs/images/embassy_irq.png (renamed from docs/modules/ROOT/images/embassy_irq.png)bin134158 -> 134158 bytes
-rw-r--r--docs/index.adoc1
-rw-r--r--docs/modules/ROOT/nav.adoc19
9 files changed, 11 insertions, 21 deletions
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 000000000..eadcf2370
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,8 @@
1all:
2 asciidoctor -d book -D thebook/ index.adoc
3 cp -r images thebook
4
5clean:
6 rm -rf thebook
7
8.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 @@
1# embassy docs 1# embassy docs
2 2
3The 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: 3The 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:
4 4
5``` 5```
6asciidoctor -d book -D thebook/ index.adoc 6make
7``` 7```
8 8
9Then open the generated file `thebook/index.html`. 9Then open the generated file `thebook/index.html`.
diff --git a/docs/modules/ROOT/images/bootloader_flash.png b/docs/images/bootloader_flash.png
index 635783b05..635783b05 100644
--- a/docs/modules/ROOT/images/bootloader_flash.png
+++ b/docs/images/bootloader_flash.png
Binary files differ
diff --git a/docs/modules/ROOT/images/embassy_executor.drawio b/docs/images/embassy_executor.drawio
index b76587d97..b76587d97 100644
--- a/docs/modules/ROOT/images/embassy_executor.drawio
+++ b/docs/images/embassy_executor.drawio
diff --git a/docs/modules/ROOT/images/embassy_executor.png b/docs/images/embassy_executor.png
index 2a83a3adb..2a83a3adb 100644
--- a/docs/modules/ROOT/images/embassy_executor.png
+++ b/docs/images/embassy_executor.png
Binary files differ
diff --git a/docs/modules/ROOT/images/embassy_irq.drawio b/docs/images/embassy_irq.drawio
index aa439a8e6..aa439a8e6 100644
--- a/docs/modules/ROOT/images/embassy_irq.drawio
+++ b/docs/images/embassy_irq.drawio
diff --git a/docs/modules/ROOT/images/embassy_irq.png b/docs/images/embassy_irq.png
index 154d336b6..154d336b6 100644
--- a/docs/modules/ROOT/images/embassy_irq.png
+++ b/docs/images/embassy_irq.png
Binary files differ
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 @@
4:toc: 4:toc:
5:toc-placement: left 5:toc-placement: left
6:toclevels: 2 6:toclevels: 2
7:imagesdir: images
7 8
8# Embassy Book 9# Embassy Book
9 10
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 @@
1* xref:getting_started.adoc[Getting started]
2** xref:basic_application.adoc[Basic application]
3** xref:project_structure.adoc[Project Structure]
4** xref:new_project.adoc[Starting a new Embassy project]
5** xref:best_practices.adoc[Best Practices]
6* xref:runtime.adoc[Executor]
7* xref::time_keeping.adoc[Time-keeping]
8* xref:sharing_peripherals.adoc[Sharing peripherals]
9* xref:hal.adoc[HAL]
10** xref:layer_by_layer.adoc[Anatomy of an async HAL]
11** xref:nrf.adoc[nRF]
12** xref:stm32.adoc[STM32]
13* xref:bootloader.adoc[Bootloader]
14
15* xref:examples.adoc[Examples]
16* xref:developer.adoc[Developer Docs]
17** xref:developer_stm32.adoc[Developer Docs: STM32]
18* xref:embassy_in_the_wild.adoc[Embassy in the wild]
19* xref:faq.adoc[Frequently Asked Questions]