move images and add makefile
This commit is contained in:
parent
739e5861c2
commit
2991099daa
9 changed files with 11 additions and 21 deletions
8
docs/Makefile
Normal file
8
docs/Makefile
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
all:
|
||||||
|
asciidoctor -d book -D thebook/ index.adoc
|
||||||
|
cp -r images thebook
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -rf thebook
|
||||||
|
|
||||||
|
.PHONY: all clean
|
|
@ -1,9 +1,9 @@
|
||||||
# embassy docs
|
# 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`.
|
Then open the generated file `thebook/index.html`.
|
||||||
|
|
Before ![]() (image error) Size: 31 KiB After ![]() (image error) Size: 31 KiB ![]() ![]() |
Before ![]() (image error) Size: 118 KiB After ![]() (image error) Size: 118 KiB ![]() ![]() |
Before ![]() (image error) Size: 131 KiB After ![]() (image error) Size: 131 KiB ![]() ![]() |
|
@ -4,6 +4,7 @@
|
||||||
:toc:
|
:toc:
|
||||||
:toc-placement: left
|
:toc-placement: left
|
||||||
:toclevels: 2
|
:toclevels: 2
|
||||||
|
:imagesdir: images
|
||||||
|
|
||||||
# Embassy Book
|
# Embassy Book
|
||||||
|
|
||||||
|
|
|
@ -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]
|
|
Loading…
Add table
Reference in a new issue