alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-09 20:41:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: This is a quick reference of more than a dozen and-ons and extensions prepared over the last two years to add contents, improve look & feel and cut on maintenance of the ESP-IDF documentation.

Browse Source
This commit is contained in:
krzychb
2019-02-10 19:14:28 +01:00
parent 2ce401c664
commit ed0db52f74
8 changed files with 96 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/api-reference/kconfig.rst
View File

@@ -15,6 +15,8 @@ When updating ESP-IDF version, it is not uncommon to find that new Kconfig optio
In some cases, such as when ``sdkconfig`` file is under revision control, the fact that ``sdkconfig`` file gets changed by the build system may be inconvenient. The build system offers a way to avoid this, in the form of ``sdkconfig.defaults`` file. This file is never touched by the build system, and must be created manually. It can contain all the options which matter for the given application. The format is the same as that of the ``sdkconfig`` file. Once ``sdkconfig.defaults`` is created, ``sdkconfig`` can be deleted and added to the ignore list of the revision control system (e.g. ``.gitignore`` file for git). Project build targets will automatically create ``sdkconfig`` file, populated with the settings from ``sdkconfig.defaults`` file, and the rest of the settings will be set to their default values. Note that when ``make defconfig`` is used, settings in sdkconfig will be overriden by the ones in ``sdkconfig.defaults``. For more information, see :ref:`custom-sdkconfig-defaults`.
.. _configuration-options-reference:
Configuration Options Reference
===============================

8
docs/en/api-reference/template.rst
View File

@@ -5,8 +5,6 @@ API Documentation Template
*INSTRUCTIONS*
1. Use this file (:idf_file:`docs/api-reference/template.rst`) as a template to document API.
2. Change the file name to the name of the header file that represents documented API.
3. Include respective files with descriptions from the API folder using ``..include::``
@@ -79,9 +77,9 @@ API Reference
.. include:: /_build/inc/esp_wifi.inc
For example see :idf_file:`docs/api-reference/wifi/esp_wifi.rst`
For example see :idf_file:`docs/en/api-reference/wifi/esp_wifi.rst`
6. Optionally, rather that using ``*.inc`` files, you may want to describe API in you own way. See :idf_file:`docs/api-reference/system/deep_sleep.rst` for example.
6. Optionally, rather that using ``*.inc`` files, you may want to describe API in you own way. See :idf_file:`docs/en/api-guides/ulp-cmake.rst` for example.
Below is the list of common ``.. doxygen...::`` directives:
@@ -101,5 +99,3 @@ API Reference
7. In any case, to generate API reference, the file :idf_file:`docs/Doxyfile` should be updated with paths to ``*.h`` headers that are being documented.
8. When changes are committed and documentation is build, check how this section has been rendered. :doc:`Correct annotations <../contribute/documenting-code>` in respective header files, if required.