esp-idf/.readthedocs.yml

# .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:
  - 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 documentation build by Doxygen
submodules: 
  include:
    - components/mqtt/esp-mqtt
Fix Breathe version to avoid docs build failure on ReadTheDocs server. Provide RTD project configuration file to be able to select python version for specific esp-idf release. (backport v3.2) 2019-05-23 07:57:43 -04:00			`# .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:`
			`- pdf`

			`# Optionally set the version of Python and requirements required to build your docs`
			`python:`
			`version: 2.7`
			`install:`
docs: Add mqtt submodule to RTD build configuration to correct file and delete similar file with typo in filename 2019-06-20 23:04:19 -04:00			`- requirements: docs/requirements.txt`

docs: Remove building of zipped HTML docs from build process and consequently from Downloads as many users don't use that. We are still providing PDF documentation for people who prefer viewing docs off-line. Removal of this build step is expected to save almost 10 minutes of build time and resolve issue of build failures because of hitting 40 min build time limit on Read The Docs. 2019-07-27 19:28:15 -04:00			`# We need to list all the submodules included in documentation build by Doxygen`
docs: Add mqtt submodule to RTD build configuration to correct file and delete similar file with typo in filename 2019-06-20 23:04:19 -04:00			`submodules:`
			`include:`
			`- components/mqtt/esp-mqtt`