pioduino/esp-idf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Provide translation for the updates in 7637 and 8095, and correct a format issue in documenting-code

Browse Source
This commit is contained in:
liying
2020-03-20 19:49:36 +08:00
committed by bot
parent bc3b95f68b
commit 572ef008a9
5 changed files with 53 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/contribute/documenting-code.rst
+4 -2
View File
@@ -383,7 +383,8 @@ You can setup environment to build documentation locally on your PC by installin
6. Blockdiag - http://blockdiag.com/en/index.html
7. Recommonmark - https://github.com/rtfd/recommonmark
The package "sphinx_idf_theme" is added to have the same "look and feel" of `ESP32 Programming Guide <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/index.html>`_.
The package "sphinx_idf_theme" is added to have the same "look and feel" of `ESP-IDF Programming Guide <https://docs.espressif.com/projects/esp-idf/en/latest/index.html>`_.
Do not worry about being confronted with several packages to install. Besides Doxygen and sphinx_idf_theme, all remaining packages are written in pure Python. Therefore installation of all of them is combined into one simple step.
@@ -437,9 +438,10 @@ Installation of Doxygen is OS dependent:
sphinx_idf_theme
@@@@@@@@@@@@@@@@
The ``sphinx_idf_theme`` needs a mixture of Python and JavaScript in order to build. So currently it's necessary install `node.js <https://nodejs.org/en/download/>` in order to build it locally.
The ``sphinx_idf_theme`` needs a mixture of Python and JavaScript in order to build. So currently it's necessary install `node.js <https://nodejs.org/en/download/>`_ in order to build it locally.
::
cd ~/esp
git clone https://github.com/espressif/sphinx_idf_theme.git
cd sphinx_idf_theme