Merge branch 'bugfix/upgrade_sphinx_and_breathe' into 'master'

igrr · igrr · commit f34a56143dd7 · 2017-11-05T21:44:26.000+08:00
Upgraded Sphinx to latest release 1.6.5 that contains a fix to https://github.co… See merge request !1476
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,6 +1,6 @@
 # This is a list of python packages used to generate documentation. This file is used with pip:
 # pip install -r requirements.txt
 #
-sphinx==1.6.3
+sphinx==1.6.5
 sphinx-rtd-theme
-breathe==4.7.1
+breathe==4.7.3
diff --git a/docs/sphinx-known-warnings.txt b/docs/sphinx-known-warnings.txt
@@ -8,18 +8,11 @@
 #
 
 #
-# Sphinx known issue https://github.com/sphinx-doc/sphinx/issues/2683\
+# Sphinx known issue https://github.com/sphinx-doc/sphinx/issues/2683
 #
 _build/inc/esp_a2dp_api.inc:line: WARNING: Invalid definition: Expected identifier in nested name. [error at 21]
   union esp_a2d_mcc_t::@1  esp_a2d_mcc_t::cie
   ---------------------^
 _build/inc/esp_bt_defs.inc:line: WARNING: Invalid definition: Expected identifier in nested name. [error at 21]
   union esp_bt_uuid_t::@0  esp_bt_uuid_t::uuid
   ---------------------^
-
-#
-# Sphinx known issue https://github.com/sphinx-doc/sphinx/issues/4041
-#
-${IDF_PATH}/docs/api-reference/storage/sdmmc.rst:line: WARNING: cpp:typeOrConcept targets a member (sdmmc_host_t::slot).
-${IDF_PATH}/docs/api-reference/storage/sdmmc.rst:line: WARNING: cpp:typeOrConcept targets a member (sdmmc_host_t::slot).
-${IDF_PATH}/docs/api-reference/storage/sdmmc.rst:line: WARNING: cpp:typeOrConcept targets a member (sdmmc_host_t::slot).

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`# This is a list of python packages used to generate documentation. This file is used with pip:`
`2`	`2`	`# pip install -r requirements.txt`
`3`	`3`	`#`
`4`		`-sphinx==1.6.3`
	`4`	`+sphinx==1.6.5`
`5`	`5`	`sphinx-rtd-theme`
`6`		`-breathe==4.7.1`
	`6`	`+breathe==4.7.3`
Original file line number	Diff line number	Diff line change
`@@ -8,18 +8,11 @@`
`8`	`8`	`#`
`9`	`9`
`10`	`10`	`#`
`11`		`-# Sphinx known issue https://github.com/sphinx-doc/sphinx/issues/2683\`
	`11`	`+# Sphinx known issue https://github.com/sphinx-doc/sphinx/issues/2683`
`12`	`12`	`#`
`13`	`13`	`_build/inc/esp_a2dp_api.inc:line: WARNING: Invalid definition: Expected identifier in nested name. [error at 21]`
`14`	`14`	`union esp_a2d_mcc_t::@1 esp_a2d_mcc_t::cie`
`15`	`15`	`---------------------^`
`16`	`16`	`_build/inc/esp_bt_defs.inc:line: WARNING: Invalid definition: Expected identifier in nested name. [error at 21]`
`17`	`17`	`union esp_bt_uuid_t::@0 esp_bt_uuid_t::uuid`
`18`	`18`	`---------------------^`
`19`		`-`
`20`		`-#`
`21`		`-# Sphinx known issue https://github.com/sphinx-doc/sphinx/issues/4041`
`22`		`-#`
`23`		`-${IDF_PATH}/docs/api-reference/storage/sdmmc.rst:line: WARNING: cpp:typeOrConcept targets a member (sdmmc_host_t::slot).`
`24`		`-${IDF_PATH}/docs/api-reference/storage/sdmmc.rst:line: WARNING: cpp:typeOrConcept targets a member (sdmmc_host_t::slot).`
`25`		`-${IDF_PATH}/docs/api-reference/storage/sdmmc.rst:line: WARNING: cpp:typeOrConcept targets a member (sdmmc_host_t::slot).`