docs: Upgraded Sphinx, Breathe and Blockdiag to the latest versions following ESP-IDF

Author: krzychb

docs/check_doc_warnings.sh

@@ -18,8 +18,7 @@ fi
 # the Sphinx warning log
 # (escape char removal from https://www.commandlinefu.com/commands/view/6141/remove-color-codes-special-characters-with-sed
 sed -r 's:\x1B\[[0-9;]*[mK]::g' sphinx-warning-log.txt | \
-    sed -E "s~${IDF_PATH}~\${IDF_PATH}~" | \
-    sed -E "s/:[0-9]+:/:line:/" > sphinx-warning-log-sanitized.txt
+    sed -E "s/.*\/(.*):[0-9]+:/\1:line:/" > sphinx-warning-log-sanitized.txt
 
 # diff sanitized warnings, ignoring lines which only appear in ../sphinx-known-warnings.txt
 

docs/requirements.txt

@@ -1,11 +1,11 @@
 # This is a list of python packages used to generate documentation. This file is used with pip:
-# pip install -r requirements.txt
+# pip install --user -r requirements.txt
 #
-sphinx==1.6.5
+sphinx>=1.6.5
 sphinx-rtd-theme
-breathe==4.7.3
-sphinxcontrib.blockdiag==1.5.3
-sphinxcontrib.seqdiag==0.8.5
-sphinxcontrib.actdiag==0.8.5
-sphinxcontrib.nwdiag==0.9.5
-recommonmark
+breathe>=4.7.3
+sphinxcontrib-blockdiag>=1.5.3
+sphinxcontrib-seqdiag>=0.8.5
+sphinxcontrib-actdiag>=0.8.5
+sphinxcontrib-nwdiag>=0.9.5
+recommonmark

docs/sphinx-known-warnings.txt

@@ -8,5 +8,10 @@
 #
 
 #
-# Sphinx known issue https://github.com/sphinx-doc/sphinx/issues/2683\
+# Breathe known issue: https://github.com/michaeljones/breathe/issues/405
+# Sphinx known issue: https://github.com/sphinx-doc/sphinx/pull/5901
 #
+audio_def.inc:line: WARNING: Duplicate declaration, audio_err_t
+audio_def.inc:line: WARNING: Duplicate declaration, esp_audio_status_t
+esp_audio.inc:line: WARNING: Duplicate declaration, struct esp_audio_cfg_t  esp_audio_cfg_t
+esp_audio.inc:line: WARNING: Duplicate declaration, struct esp_audio_setup_t  esp_audio_setup_t