File: .readthedocs.yaml

package info (click to toggle)
mir 2.20.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 20,636 kB
  • sloc: cpp: 174,574; xml: 13,422; ansic: 8,221; python: 1,337; sh: 874; makefile: 216; javascript: 37
file content (59 lines) | stat: -rw-r--r-- 1,430 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.11"
  # https://github.com/readthedocs/readthedocs.org/issues/9599
  apt_packages:
  - cmake
  - libboost-dev
  - libboost-iostreams-dev
  - libboost-filesystem-dev
  - libboost-program-options-dev
  - libboost-system-dev
  - libdrm-dev
  - libegl-dev
  - libepoxy-dev
  - libfreetype-dev
  - libglib2.0-dev
  - libgles2-mesa-dev
  - libglm-dev
  - libinput-dev
  - liblttng-ust-dev
  - libwayland-dev
  - libxcb-composite0-dev
  - libxcb-randr0-dev
  - libxcursor-dev
  - libxkbcommon-dev
  - libxml++2.6-dev
  - libyaml-cpp-dev
  - xsltproc
  jobs:
    post_checkout:
    - ( cd doc/sphinx; python3 .sphinx/build_requirements.py )
    - git fetch --unshallow
    post_install:
    - cmake -DMIR_ENABLE_TESTS=NO -DMIR_PLATFORM=x11 .
    - cmake --build . --target guides

# Build documentation in the docs/ directory with Sphinx
sphinx:
  builder: dirhtml
  configuration: doc/sphinx/conf.py
  fail_on_warning: false

# If using Sphinx, optionally build your docs in additional formats such as PDF
formats:
   - pdf

# Optionally declare the Python requirements required to build your docs
python:
   install:
   - requirements: doc/sphinx/.sphinx/requirements.txt