forked from labscript-suite/runviewer
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathreadthedocs.yaml
More file actions
38 lines (32 loc) · 1002 Bytes
/
readthedocs.yaml
File metadata and controls
38 lines (32 loc) · 1002 Bytes
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
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set build environment options
build:
os: ubuntu-22.04
tools:
python: "3.11"
jobs:
# ensure full git repo is pulled so setuptools_scm gets versions correctly on install
# https://docs.readthedocs.com/platform/stable/build-customization.html#unshallow-git-clone
post_checkout:
- git fetch --unshallow || true
- git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*' || true
- git fetch --all --tags || true
# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: dirhtml
configuration: docs/source/conf.py
fail_on_warning: false
# Optionally build your docs in additional formats such as PDF
formats:
- pdf
- epub
# Optionally set the requirements required to build your docs
python:
install:
- method: pip
path: .
extra_requirements:
- docs