Docs build.job recipe for poetry does not work with newer versions

[davidorme]

I'm trying to build a site for a package managed using poetry and following the officially documented approach in the build.jobs docs section. That approach now appears to be failing:

https://readthedocs.org/projects/virtual-rainforest/builds/18663328/

The TLDR on that build log error is that the old get-poetry.py install will not install recent versions (>1.2.0a1) and that the new https://install.python-poetry.org approach must be used instead. I tried using that approach:

build:
  os: ubuntu-20.04
  tools:
    python: "3.9"
  jobs:
    post_create_environment:
      # Install poetry
      - curl -sSL https://install.python-poetry.org | python3 -
      # Tell poetry to not use a virtual environment
      - $HOME/.local/bin/poetry config virtualenvs.create false
      # Install project's dependencies
      - $HOME/.local/bin/poetry install

but that doesn't seem to be working: https://readthedocs.org/projects/virtual-rainforest/builds/18663177/

I know that is an apparent error in my package, but it doesn't occur with local sphinx builds and seems like a problem with the installed environment? I think @humitos tried this approach and also had problems with the resulting build environment :

#9445 (comment)

Originally posted by @davidorme in #9445 (comment)

[browniebroke]

I also noticed that the docs were out of date and I tried to update them in #9743

I think I'm facing the same issue: my package doesn't get installed. From what I can tell, the last line poetry install doesn't install the dependecies in the right virtualenv.

EDIT: see pull request for improved version:

• Docs: update instructions to install deps with Poetry #9743

Old solution (pre-edit)

I managed to make my build work with the following solution:

build:
  os: ubuntu-20.04
  tools:
    python: "3.9"
  jobs:
    post_create_environment:
      # Install poetry
      # https://python-poetry.org/docs/#osx--linux--bashonwindows-install-instructions
      - curl -sSL https://install.python-poetry.org | python3 -
      # Tell poetry to not use a virtual environment
      - $HOME/.local/bin/poetry config virtualenvs.create false
    pre_install:
      # Export project dependencies to requirements.txt
      - $HOME/.local/bin/poetry export --with docs > docs/requirements.txt

python:
  install:
    # Install exported dependencies
    - requirements: docs/requirements.txt
    # Install the current package itself
    - method: pip
      path: .

Not ideal though.

[browniebroke]

From what I can tell, the last line poetry install doesn't install the dependecies in the right virtualenv.

Just expanding a bit on that. I think this is what happens:

1. RTD installs the specified Python version with asdf
2. RTD creates a virtualenv using that Python version
3. The 1st command in post_create_environment installs Poetry using the Python version from step 1
4. The 3rd command that calls poetry install installs the project dependencies in the global Python from step 1, NOT in the virtualenv from step 2
5. The rest of the RTD build runs everything in the virtyalenv, where the Poetry dependencies are not installed

[davidorme]

Maybe there needs to be an added poetry env use ... to tell poetry explicitly which environment to use?

[davidorme]

Just to note that #9743 fixes this for my project.