Skip to content

Commit f95b41e

Browse files
committed
readme: add documentation details
Inform the users on how to quickly build the documentation. Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
1 parent df944a8 commit f95b41e

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

+34
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ applications. Some of the features demonstrated in this example are:
2121
- Out-of-tree libraries
2222
- Example CI configuration (using Github Actions)
2323
- Custom [west extension][west_ext]
24+
- Doxygen and Sphinx documentation boilerplate
2425

2526
This repository is versioned together with the [Zephyr main tree][zephyr]. This
2627
means that every time that Zephyr is tagged, this repository is tagged as well
@@ -94,3 +95,36 @@ To execute Twister integration tests, run the following command:
9495
```shell
9596
west twister -T tests --integration
9697
```
98+
99+
### Documentation
100+
101+
A minimal documentation setup is provided for Doxygen and Sphinx. To build the
102+
documentation first change to the ``doc`` folder:
103+
104+
```shell
105+
cd doc
106+
```
107+
108+
Before continueing, check if you have Doxygen installed. It is recommended to
109+
use the same Doxygen version used in [CI](.github/workflows/docs.yml). To
110+
install Sphinx, make sure you have a Python installation in place and run:
111+
112+
```shell
113+
pip install -r requirements.txt
114+
```
115+
116+
API documentation (Doxygen) can be built using the following command:
117+
118+
```shell
119+
doxygen
120+
```
121+
122+
The output will be stored in the ``_build_doxygen`` folder. Similarly, the
123+
Sphinx documentation (HTML) can be built using the following command:
124+
125+
```shell
126+
make html
127+
```
128+
129+
The output will be stored in the ``_build_sphinx`` folder. You may check for
130+
other output formats other than HTML by running ``make help``.

0 commit comments

Comments
 (0)