docs:update CN translation for documenting-code and LEDC

This commit is contained in:
Dai Zi Yan
2021-03-23 10:52:50 +08:00
committed by Krzysztof Budzynski
parent 67ba80f2ec
commit 8ae944e26c
4 changed files with 68 additions and 50 deletions
+2 -3
View File
@@ -5,7 +5,6 @@ Documenting Code
The purpose of this description is to provide quick summary on documentation style used in `espressif/esp-idf`_ repository and how to add new documentation.
Introduction
------------
@@ -251,7 +250,8 @@ Writing generic documentation for multiple chips
The documentation for all of Espressif's chips is built from the same files. To faciliate the writing of documents that can be re-used for multiple different chips (called below "targets"), we provide you with the following functionality:
Exclusion of content based on chip-target
"""""""""""""""""""""""""""""""""""""""""
""""""""""""""""""""""""""""""""""""""""""""
Occasionally there will be content that is only relevant for one of targets. When this is the case, you can exclude that content by using the ''.. only:: TAG'' directive, where you replace 'TAG' with one of the following names:
Chip name:
@@ -407,7 +407,6 @@ 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 `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, all remaining packages are written in pure Python. Therefore installation of all of them is combined into one simple step.