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 documenation build by Doxygen
submodules:
  include:
    - components/mqtt/esp-mqtt
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. 2019-05-03 09:18:18 -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. Now any submodule included in documentation build by Doxygen should be included in this file 2019-05-28 08:09:08 -04:00			`- requirements: docs/requirements.txt`

fix(docs): Updated .readthedocs.yml Minor typing error fix in .readthedocs.yml file. Closes https://github.com/espressif/esp-idf/pull/13191 2024-02-15 18:52:03 -05:00			`# We need to list all the submodules included in documenation build by Doxygen`
Whitespace: Automated whitespace fixes (large commit) Apply the pre-commit hook whitespace fixes to all files in the repo. (Line endings, blank lines at end of file, trailing whitespace) 2020-11-10 02:40:01 -05:00			`submodules:`
docs: Add mqtt submodule to RTD build configuration. Now any submodule included in documentation build by Doxygen should be included in this file 2019-05-28 08:09:08 -04:00			`include:`
Whitespace: Automated whitespace fixes (large commit) Apply the pre-commit hook whitespace fixes to all files in the repo. (Line endings, blank lines at end of file, trailing whitespace) 2020-11-10 02:40:01 -05:00			`- components/mqtt/esp-mqtt`