Re: [PATCH 4/4] .readthedocs.yml: Set our requirements file

Heinrich Schuchardt
2022-01-12T02:33:30Z

On 1/12/22 01:14, Tom Rini wrote:
> We provide a requirements.txt file for doc building, but had not been
> configuring readthedocs to know where it is.
>
> Cc: Heinrich Schuchardt <xypron.glpk@gmx.de>
> Signed-off-by: Tom Rini <trini@konsulko.com>
> ---
> .readthedocs.yml | 9 ++++----- > 1 file changed, 4 insertions(+), 5 deletions(-)
>
> diff --git a/.readthedocs.yml b/.readthedocs.yml
> index 44949ea239d8..c6f47b3e07e9 100644
> --- a/.readthedocs.yml
> +++ b/.readthedocs.yml
> @@ -12,8 +12,7 @@ sphinx:
> # Optionally build your docs in additional formats such as PDF and ePub
> formats: []
>
> -# Optionally set the version of Python and requirements required to build your docs
> -# python:
> -# version: 3.7
> -# install:
> -# - requirements: docs/requirements.txt
> +# Explicitly set the requirements file
> +python:
> + install:
> + - requirements: doc/sphinx/requirements.txt

I could not get it running without install python3-six:

# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

build:
os: "ubuntu-20.04"
apt_packages:
- python3-six
tools:
python: "3.9"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: doc/conf.py

# Optionally build your docs in additional formats such as PDF and ePub
formats: []

python:
install:
- requirements: doc/sphinx/requirements.txt

Best regards

Heinrich