Skip to content

Commit 8a48f5b

Browse files
Jesse Clavenjesse-c
Jesse Claven
authored andcommitted
build: Bump versions for Read the Docs (#1761)
* build: Bump versions for Read the Docs We don't support Python `3.8` anymore. Poetry `1.8.1` matches what's currently in our Poetry lockfile. Building the docs is currently failing [1], and this ideally will fix that. [1] From readthedocs.org: ``` poetry install -vvv --without dev --with docs --with all-runtimes --with all-runtimes-dev Loading configuration file /home/docs/.config/pypoetry/config.toml The currently activated Python version 3.8.18 is not supported by the project (>=3.9,<3.12). Trying to find and use a compatible version. Trying python3 Trying python3.9 ``` * docs: Bump copyright year * build: Use Python env for server * build: Use recommended Read the Docs setup There's still been some failures [2], so I've updated it to follow their recommendation [1]. [1] https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-poetry [2] ``` Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/mlserver/envs/1761/lib/python3.10/site-packages/sphinx/config.py", line 509, in eval_config_file exec(code, namespace) # NoQA: S102 File "/home/docs/checkouts/readthedocs.org/user_builds/mlserver/checkouts/1761/docs/conf.py", line 19, in <module> import sphinx_material ModuleNotFoundError: No module named 'sphinx_material' ```
1 parent f9db7ab commit 8a48f5b

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

.readthedocs.yaml

+6-5
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,17 @@ formats:
1616
build:
1717
os: ubuntu-22.04
1818
tools:
19-
python: "3.8"
19+
python: "3.10"
2020
jobs:
2121
# Set up Poetry
2222
# From https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-poetry
2323
post_create_environment:
2424
# Install poetry
2525
# https://python-poetry.org/docs/#installing-manually
26-
- pip install poetry==1.4.2
27-
# Tell poetry to not use a virtual environment
28-
- poetry config virtualenvs.create false
26+
- pip install poetry==1.8.1
27+
post_install:
2928
# Install dependencies with 'docs' dependency group
3029
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
31-
- poetry install -vvv --without dev --with docs --with all-runtimes --with all-runtimes-dev
30+
# VIRTUAL_ENV needs to be set manually for now.
31+
# See https://github.com/readthedocs/readthedocs.org/pull/11152/
32+
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install -vvv --without dev --with docs --with all-runtimes --with all-runtimes-dev

docs/Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ help:
2020
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2121

2222
start:
23-
sphinx-autobuild . ./_build/html
23+
poetry run sphinx-autobuild . ./_build/html
2424

2525
install-dev:
2626
poetry install -C .. --with docs --with all-runtimes --with all-runtimes-dev

docs/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
import sphinx_material
2020

2121
project = "MLServer"
22-
copyright = "2023, Seldon Technologies"
22+
copyright = "2024, Seldon Technologies"
2323
html_title = "MLServer Documentation"
2424
author = "Seldon Technologies"
2525

0 commit comments

Comments
 (0)