Skip to content

Commit e8f3213

Browse files
committed
Add Read the Docs configuration file for Sphinx documentation
1 parent 6846cbe commit e8f3213

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

.readthedocs.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
version: 2
5+
build:
6+
os: ubuntu-22.04
7+
tools:
8+
python: "3.11"
9+
apt_packages:
10+
- xvfb
11+
- libxkbcommon-x11-0
12+
- libxcb-icccm4
13+
- libxcb-image0
14+
- libxcb-keysyms1
15+
- libxcb-randr0
16+
- libxcb-render-util0
17+
- libxcb-xinerama0
18+
- libxcb-xfixes0
19+
jobs:
20+
pre_build:
21+
# Start Xvfb before building docs
22+
- "Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &"
23+
- "export DISPLAY=:99"
24+
sphinx:
25+
configuration: doc/conf.py
26+
formats:
27+
- pdf
28+
python:
29+
install:
30+
- method: pip
31+
path: .
32+
extra_requirements:
33+
- doc

0 commit comments

Comments
 (0)