Skip to content

Commit ef0443f

Browse files
denyeartale-linux
authored andcommittedAug 16, 2023
Add readthedocs config file
Add readthedocs config file. Signed-off-by: David Enyeart <enyeart@us.ibm.com>
1 parent c2be53a commit ef0443f

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed
 

‎.readthedocs.yaml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# SPDX-License-Identifier: Apache-2.0
2+
3+
# Read the Docs configuration file for Sphinx projects
4+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
5+
6+
# Required
7+
version: 2
8+
9+
# Set the OS, Python version and other tools you might need
10+
build:
11+
os: ubuntu-22.04
12+
tools:
13+
python: "3.11"
14+
# You can also specify other tool versions:
15+
# nodejs: "20"
16+
# rust: "1.70"
17+
# golang: "1.20"
18+
19+
# Build documentation in the "docs/" directory with Sphinx
20+
sphinx:
21+
configuration: docs/source/conf.py
22+
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
23+
# builder: "dirhtml"
24+
# Fail on all warnings to avoid broken references
25+
# fail_on_warning: true
26+
27+
# Optionally build your docs in additional formats such as PDF and ePub
28+
# formats:
29+
# - pdf
30+
# - epub
31+
32+
# Optional but recommended, declare the Python requirements required
33+
# to build your documentation
34+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
35+
python:
36+
install:
37+
- requirements: docs/requirements.txt

0 commit comments

Comments
 (0)