Merge branch 'bugfix/docs_rtd_failure_on_missing_submodule_v3_2' into 'release/v3.2'

docs: Add mqtt submodule to RTD build configuration. Now any submodule... See merge request idf/esp-idf!5286
2019-06-20 08:07:51 +08:00 · 2019-06-20 08:07:51 +08:00 · 5d7d46a76d
commit 5d7d46a76d
parent fa42f63226 eaaad51f81
1 changed files with 22 additions and 0 deletions
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@ -0,0 +1,22 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - htmlzip
+  - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 2.7
+  install:
+    - requirements: docs/requirements.txt
+
+# We need to list all the submodules included in documenation build by Doxygen
+submodules: 
+  include:
+    - components/mqtt/esp-mqtt