-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy path.readthedocs.yaml
More file actions
44 lines (38 loc) · 1018 Bytes
/
.readthedocs.yaml
File metadata and controls
44 lines (38 loc) · 1018 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
39
40
41
42
43
44
# .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 OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
jobs:
post_create_environment:
# Install poetry if needed
- pip install poetry
post_install:
# Install any additional dependencies
- echo "Build environment ready"
# Build documentation in the doc-tyxonq directory with Sphinx
sphinx:
configuration: doc-tyxonq/source/conf.py
fail_on_warning: false
# Optionally build your docs in additional formats such as PDF and ePub
formats:
- pdf
- epub
# Optional but recommended, declare the Python requirements required
# to build your documentation
python:
install:
- requirements: doc-tyxonq/requirements.txt
- method: pip
path: .
extra_requirements:
- docs
# Submodules configuration
submodules:
include: []
recursive: false