Lines Matching +full:- +full:- +full:non +full:- +full:interactive

6 …on is to provide quick summary on documentation style used in `espressif/esp-idf`_ repository and …
9 ------------
21 .. image:: ../../_static/doc-code-documentation-inline.png
29 ---------------
35 .. image:: ../../_static/doc-code-documentation-rendered.png
41 ----------
51     .. image:: ../../_static/doc-code-function.png
57     .. image:: ../../_static/doc-code-void-function.png
63     .. image:: ../../_static/doc-code-member.png
71     *    - ESP_OK if erase operation was successful
72     *    - ESP_ERR_NVS_INVALID_HANDLE if handle has been closed or is NULL
73     *    - ESP_ERR_NVS_READ_ONLY if handle was opened as read only
74     *    - ESP_ERR_NVS_NOT_FOUND if the requested key doesn't exist
75     *    - other error codes from the underlying storage driver
78 …tory contains header files for different APIs, then the file name should be ``apiname-readme.rst``.
82 -----------------
141 -------------------------------
147     .. figure:: ../../_static/doc-format1-recommend.png
150         :alt: One line for one paragraph - recommend (click to enlarge)
154     .. figure:: ../../_static/doc-format2-notrecommend.png
157         :alt: One line for one paragraph - not recommend (click to enlarge)
161 … approach is that it can save time for both writers and translators. When non-bilingual writers ne…
163     .. figure:: ../../_static/doc-format3-recommend.png
171 ----------------------
172 …e documentation is built with the `esp-docs` Python package, which is a wrapper around `Sphinx <ht…
176     pip install esp-docs
180     build-docs build
184     build-docs -t esp32 -l en build
186 For more in-depth documentation about `esp-docs` features please see the `esp-doc` documentation.
189 -------
198 -----------------
200 * :doc:`../api-reference/template`
203 .. _espressif/esp-idf: https://github.com/espressif/esp-idf/
205 …interactive.blockdiag.com/?compression=deflate&src=eJxlUMFOwzAMvecrrO3aITYQQirlAIIzEseJQ5q4TUSIq8T…