adafruit-mirror/arduino-esp32
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix documentation build instructions (#9350)

Browse source
This commit is contained in:
Lucas Saavedra Vaz 2024-03-11 10:11:13 -03:00 committed by GitHub
parent dce754b693
commit 2479efb10d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/en/guides/docs_contributing.rst
View file

@ -72,11 +72,11 @@ We also recommend you install to grammar check extension to help you to review E
Building
********
To build the documentation and generate the HTLM files, you can use the following command inside the ``docs`` folder. After a successful build, you can check the files inside the `build/html` folder.
To build the documentation and generate the HTML files, you can use the following command inside the ``docs`` folder. After a successful build, you can check the files inside the `_build/en/generic/html` folder.
.. code-block::
make html
build-docs -l en
This step is essential to ensure that there are no syntax errors and also to see the final result.
@ -104,7 +104,7 @@ If everything is ok, you will see some output logs similar to this one:
dumping object inventory... done
build succeeded.
The HTML pages are in build/html.
The HTML pages are in `_build/en/generic/html`.
Sections
--------