-
Notifications
You must be signed in to change notification settings - Fork 2
/
.readthedocs.yaml
39 lines (35 loc) · 1.39 KB
/
.readthedocs.yaml
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
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Version of this Read the Docs configuration file.
version: 2
# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.9"
jobs:
post_checkout:
# Download and uncompress the binary
# https://git-lfs.github.com/
- wget https://github.com/git-lfs/git-lfs/releases/download/v3.4.0/git-lfs-linux-amd64-v3.4.0.tar.gz
- tar xvfz git-lfs-linux-amd64-v3.4.0.tar.gz
- ln -s ./git-lfs-3.4.0/git-lfs git-lfs
# Modify LFS config paths to point where git-lfs binary was downloaded
- git config filter.lfs.process "`pwd`/git-lfs filter-process"
- git config filter.lfs.smudge "`pwd`/git-lfs smudge -- %f"
- git config filter.lfs.clean "`pwd`/git-lfs clean -- %f"
# Make LFS available in current repository
- ./git-lfs install
# Download content from remote
- ./git-lfs fetch
# Make local files to have the real content on them
- ./git-lfs checkout
# Build documentation in the docs/ directory with Sphinx.
sphinx:
configuration: docs/conf.py
# Pin the version of Python and requirements required to build the docs.
# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt