From 7a19f65f589a91255ac8750190fd87f68f947c38 Mon Sep 17 00:00:00 2001 From: "kirill.chalov" Date: Wed, 21 Aug 2024 15:57:54 +0800 Subject: [PATCH] fix: update instructions for building docs --- docs/en/contribute/documenting-code.rst | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/docs/en/contribute/documenting-code.rst b/docs/en/contribute/documenting-code.rst index 1eb3dc94b8..c259d0535b 100644 --- a/docs/en/contribute/documenting-code.rst +++ b/docs/en/contribute/documenting-code.rst @@ -170,21 +170,30 @@ When it comes to text, please follow guidelines below to provide well-formatted Building Documentation ---------------------- -The documentation is built with the `esp-docs` Python package, which is a wrapper around `Sphinx `_. +To build documentation, start by installing the dependencies: -To install it simply do:: +1. Install `Doxygen `_. +2. Chances are you already set up the required `tools `_ by running ``./install.sh``. To enable building docs, you need to run: - pip install esp-docs + .. code-block:: bash -After a successful install then the documentation can be built from the docs folder with:: + ./install.sh --enable-docs + + This action will install the ``esp-docs`` Python package. This package is a wrapper around `Sphinx `_ and is required to build ESP-IDF documentation. + +After installing the dependencies, go to the ``docs`` folder and run the following to build the documentation: + +.. code-block:: bash build-docs build -or for specific target and language with:: +You can also build only the needed docs by choosing a specific target and language (it speeds up the process): + +.. code-block:: bash build-docs -t esp32 -l en build -For more in-depth documentation about `esp-docs` features please see the documentation at `esp-docs `_. +For more in-depth information, see the `esp-docs `_ documentation. Wrap Up -------