Skip to content

Commit 1a10dfe

Browse files
committed
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.
1 parent 5c8f45b commit 1a10dfe

File tree

3 files changed

+32
-7
lines changed

3 files changed

+32
-7
lines changed

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
*.i*86
3636
*.x86_64
3737
*.hex
38+
*.pyc
3839

3940
# Debug files
4041
*.dSYM/
@@ -69,3 +70,9 @@ dkms.conf
6970
**/sdkconfig
7071
**/sdkconfig.old
7172
**/build
73+
74+
# Doc build artifacts
75+
docs/*/*/_build/
76+
docs/*/*/sphinx-warning-log.txt
77+
docs/*/*/sphinx-warning-log-sanitized.txt
78+

.readthedocs.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Optionally build your docs in additional formats such as PDF and ePub
9+
formats:
10+
- htmlzip
11+
- pdf
12+
13+
# Optionally set the version of Python and requirements required to build your docs
14+
python:
15+
version: 2.7
16+
install:
17+
- requirements: docs/requirements.txt

docs/requirements.txt

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# This is a list of python packages used to generate documentation. This file is used with pip:
2-
# pip install -r requirements.txt
2+
# pip install --user -r requirements.txt
33
#
4-
sphinx==1.6.5
4+
sphinx>=1.8.4
5+
breathe==4.11.1
56
sphinx-rtd-theme
6-
breathe==4.7.3
7-
sphinxcontrib.blockdiag==1.5.3
8-
sphinxcontrib.seqdiag==0.8.5
9-
sphinxcontrib.actdiag==0.8.5
10-
sphinxcontrib.nwdiag==0.9.5
7+
sphinx-notfound-page
8+
sphinxcontrib-blockdiag>=1.5.5
9+
sphinxcontrib-seqdiag>=0.8.5
10+
sphinxcontrib-actdiag>=0.8.5
11+
sphinxcontrib-nwdiag>=0.9.5
1112
recommonmark

0 commit comments

Comments
 (0)