Explorar el Código

Fixed Breathe version to avoid docs build failure on ReadTheDocs server. Provided RTD project configuration file to be able to select python version for specific to esp-idf release.

Krzysztof hace 6 años
padre
commit
27fe2006de
Se han modificado 2 ficheros con 18 adiciones y 1 borrados
  1. 17 0
      .readthedocs.yml
  2. 1 1
      docs/requirements.txt

+ 17 - 0
.readthedocs.yml

@@ -0,0 +1,17 @@
+# .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

+ 1 - 1
docs/requirements.txt

@@ -2,7 +2,7 @@
 # pip install --user -r requirements.txt
 #
 sphinx>=1.8.4
-breathe>=4.11.1
+breathe==4.11.1
 sphinx-rtd-theme
 sphinx-notfound-page
 sphinxcontrib-blockdiag>=1.5.5