Skip to content

Commit cb3b81b

Browse files
committed
Update top configuration example
1 parent 57af10e commit cb3b81b

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

docs/config-file/v2.rst

+15-4
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ Below is an example YAML file which shows the most common configuration options:
2121
# Required
2222
version: 2
2323
24+
# Set the version of Python and other tools you might need
25+
build:
26+
os: ubuntu-20.04
27+
tools:
28+
python: "3.9"
29+
nodejs: "16"
30+
2431
# Build documentation in the docs/ directory with Sphinx
2532
sphinx:
2633
configuration: docs/conf.py
@@ -29,9 +36,8 @@ Below is an example YAML file which shows the most common configuration options:
2936
formats:
3037
- pdf
3138
32-
# Optionally set the version of Python and requirements required to build your docs
39+
# Optionally declare the Python requirements required to build your docs
3340
python:
34-
version: "3.7"
3541
install:
3642
- requirements: docs/requirements.txt
3743
@@ -46,12 +52,17 @@ Below is an example YAML file which shows the most common configuration options:
4652
# Required
4753
version: 2
4854
55+
# Set the version of Python and other tools you might need
56+
build:
57+
os: ubuntu-20.04
58+
tools:
59+
python: "3.9"
60+
4961
mkdocs:
5062
configuration: mkdocs.yml
5163
52-
# Optionally set the version of Python and requirements required to build your docs
64+
# Optionally declare the Python requirements required to build your docs
5365
python:
54-
version: "3.7"
5566
install:
5667
- requirements: docs/requirements.txt
5768

0 commit comments

Comments
 (0)