Skip to content

Commit 122f774

Browse files
committed
readthedocs: Add configuration file
Use the more powerful configuration file .readthedocs.yaml to ensure that all requirements are installed. This now includes also a distro package, python-newt, something that cannot be installed via a requirements.txt. Fixes the doc build for 2.6.x which become broken with the addition of the menu plugin. Signed-off-by: Jan Kiszka <[email protected]>
1 parent 2c0486d commit 122f774

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

.readthedocs.yaml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# kas - setup tool for bitbake based projects
2+
#
3+
# Copyright (c) Siemens AG, 2021
4+
#
5+
# Permission is hereby granted, free of charge, to any person obtaining a copy
6+
# of this software and associated documentation files (the "Software"), to deal
7+
# in the Software without restriction, including without limitation the rights
8+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
# copies of the Software, and to permit persons to whom the Software is
10+
# furnished to do so, subject to the following conditions:
11+
#
12+
# The above copyright notice and this permission notice shall be
13+
# included in all copies or substantial portions of the Software.
14+
#
15+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
# SOFTWARE.
22+
23+
version: 2
24+
25+
build:
26+
os: ubuntu-20.04
27+
tools:
28+
python: "3.9"
29+
apt_packages:
30+
- python3-newt
31+
32+
python:
33+
install:
34+
- method: setuptools
35+
path: .
36+
- requirements: docs/requirements.txt
37+
38+
sphinx:
39+
configuration: docs/conf.py
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
sphinx>=1.2.0
22
CommonMark>=0.5.6
33
sphinx-argparse>=0.2.1
4-
jsonschema>=2.5.0

0 commit comments

Comments
 (0)