Allow the extension for adding todo notes to rst files. Add information on how to use this extension to the contribution section.

docs/conf_common.py

@@ -154,8 +154,14 @@ extensions = ['breathe',
               'sphinxcontrib.rackdiag',
               'sphinxcontrib.packetdiag',
               'html_redirects',
+              'sphinx.ext.todo',
               ]
 
+# sphinx.ext.todo extension parameters
+# If the below parameter is True, the extension
+# produces output, else it produces nothing.
+todo_include_todos = False
+
 # Enabling this fixes cropping of blockdiag edge labels
 seqdiag_antialias = True
 

docs/en/contribute/documenting-code.rst

@@ -215,6 +215,35 @@ Try them out by modifying the source code and see the diagram instantly renderin
     There may be slight differences in rendering of font used by the `interactive shell`_ compared to the font used in the esp-idf documentation.
 
 
+Add Notes
+---------
+
+Working on a document, you might need to:
+
+- Place some suggestions on what should be added or modified in future.
+- Leave a reminder for yourself or somebody else to follow up.
+
+In this case, add a todo note to your reST file using the directive ``.. todo::``. For example:
+
+.. code-block:: none
+
+   .. todo::
+
+      Add a package diagram.
+
+If you add ``.. todolist::`` to a reST file, the directive will be replaced by a list of all todo notes from the whole documentation.
+
+By default, the directives ``.. todo::`` and ``.. todolist::`` are ignored by documentation builders. If you want the notes and the list of notes to be visible in your locally built documentation, do the following:
+
+1. Open your local ``conf_common.py`` file.
+2. Find the parameter ``todo_include_todos``.
+3. Change its value from ``False`` to ``True``.
+
+Before pushing your changes to origin, please set the value of ``todo_include_todos`` back to ``False``.
+
+For more details about the extension, see `its website <https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#directive-todolist>`_.
+
+
 Put it all together
 -------------------