From 71c249b86df315bceda81676c0e4720fe3a40eff Mon Sep 17 00:00:00 2001 From: Gerard Marull-Paretas Date: Wed, 3 Apr 2024 15:58:11 +0200 Subject: [PATCH] readme: add documentation details Inform the users on how to quickly build the documentation. Signed-off-by: Gerard Marull-Paretas --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index d9a039fc..010ac847 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ applications. Some of the features demonstrated in this example are: - Out-of-tree libraries - Example CI configuration (using Github Actions) - Custom [west extension][west_ext] +- Doxygen and Sphinx documentation boilerplate This repository is versioned together with the [Zephyr main tree][zephyr]. This 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: ```shell west twister -T tests --integration ``` + +### Documentation + +A minimal documentation setup is provided for Doxygen and Sphinx. To build the +documentation first change to the ``doc`` folder: + +```shell +cd doc +``` + +Before continueing, check if you have Doxygen installed. It is recommended to +use the same Doxygen version used in [CI](.github/workflows/docs.yml). To +install Sphinx, make sure you have a Python installation in place and run: + +```shell +pip install -r requirements.txt +``` + +API documentation (Doxygen) can be built using the following command: + +```shell +doxygen +``` + +The output will be stored in the ``_build_doxygen`` folder. Similarly, the +Sphinx documentation (HTML) can be built using the following command: + +```shell +make html +``` + +The output will be stored in the ``_build_sphinx`` folder. You may check for +other output formats other than HTML by running ``make help``.