From 5022bbad71d5ad1be6a105dc9617c1449ba849a6 Mon Sep 17 00:00:00 2001 From: Shubham Patil Date: Mon, 28 Jul 2025 17:59:59 +0530 Subject: [PATCH] docs: simplify the README for building docs --- docs/README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 39ad5207b..5cf6a1a1e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,4 +14,20 @@ The above URL is for the main branch latest version. Click the drop-down in the # Building Documentation -The documentation is built using the python package `esp-docs`, which can be installed by running `pip install esp-docs`. Running `build-docs --help` will give a summary of available options. For more information see the `esp-docs` documentation at https://github.com/espressif/esp-docs/blob/master/README.md +This project uses [esp-docs](https://docs.espressif.com/projects/esp-docs/en/latest/index.html) to build the documentation. + +- Install dependencies +``` +pip install -r requirements.txt +``` + +- Build documentation +``` +build-docs -bs html latex -t esp32 -l en +``` +NOTE: Above command only builds for the `esp32` target, you can add more targets to `-t` argument. + +- For more available options run: +``` +build-docs --help +```