Skip to content

Docs: update versions on config file page #9838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 22, 2022
Merged

Docs: update versions on config file page #9838

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e92f891
Docs: update versions on config file page
humitos Dec 22, 2022
6a89e1c
Update versions in reproducible-builds.rst
benjaoming Dec 22, 2022
7fde423
Update docs/user/config-file/v2.rst
humitos Dec 22, 2022
53213a9
Apply suggestions from code review
humitos Dec 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 17 additions & 16 deletions docs/user/config-file/v2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ Below is an example YAML file which shows the most common configuration options:

# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
os: ubuntu-22.04
tools:
python: "3.9"
python: "3.11"
# You can also specify other tool versions:
# nodejs: "16"
# rust: "1.55"
# golang: "1.17"
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand Down Expand Up @@ -57,9 +57,9 @@ Below is an example YAML file which shows the most common configuration options:

# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
os: ubuntu-22.04
tools:
python: "3.9"
python: "3.11"

mkdocs:
configuration: mkdocs.yml
Expand Down Expand Up @@ -201,7 +201,6 @@ Example:
version: 2

python:
version: "3.7"
install:
- requirements: docs/requirements.txt
- requirements: requirements.txt
Expand Down Expand Up @@ -249,7 +248,6 @@ Example:
version: 2

python:
version: "3.7"
install:
- method: pip
path: .
Expand Down Expand Up @@ -313,12 +311,12 @@ Python, Node.js, Rust, and Go.
version: 2

build:
os: ubuntu-20.04
os: ubuntu-22.04
tools:
python: "3.9"
nodejs: "16"
rust: "1.55"
golang: "1.17"
python: "3.11"
nodejs: "19"
rust: "1.64"
golang: "1.19"

build.os
````````
Expand Down Expand Up @@ -381,6 +379,7 @@ Node.js version to use.
- ``14``
- ``16``
- ``18``
- ``19``

build.tools.rust
````````````````
Expand All @@ -391,6 +390,7 @@ Rust version to use.
:Options:
- ``1.55``
- ``1.61``
- ``1.64``

build.tools.golang
``````````````````
Expand All @@ -401,6 +401,7 @@ Go version to use.
:Options:
- ``1.17``
- ``1.18``
- ``1.19``

build.apt_packages
``````````````````
Expand Down Expand Up @@ -444,7 +445,7 @@ See :doc:`/build-customization` for more details.
build:
os: ubuntu-22.04
tools:
python: "3.10"
python: "3.11"
jobs:
pre_create_environment:
- echo "Command run at 'pre_create_environment' step"
Expand Down Expand Up @@ -489,7 +490,7 @@ The ``_readthedocs/html`` directory (relative to the checkout's path) will be up
build:
os: ubuntu-22.04
tools:
python: "3.10"
python: "3.11"
commands:
- pip install pelican
- pelican --settings docs/pelicanconf.py --output _readthedocs/html/ docs/
Expand Down