Merge pull request #42 from BrainLesion/41-bug-read-the-docs-broken

41 bug read the docs broken

.readthedocs.yaml

@@ -1,32 +1,20 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
 version: 2
 
-# Set the version of Python and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: "ubuntu-22.04"
   tools:
     python: "3.10"
   jobs:
     post_create_environment:
       # Install poetry
       # https://python-poetry.org/docs/#installing-manually
       - pip install poetry
-      # Tell poetry to not use a virtual environment
-      - poetry config virtualenvs.create false
     post_install:
       # Install dependencies with 'docs' dependency group
       # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
-      - poetry install --with docs
+      # VIRTUAL_ENV needs to be set manually for now.
+      # See https://github.com/readthedocs/readthedocs.org/pull/11152/
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs
 
-# Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: docs/source/conf.py
-# If using Sphinx, optionally build your docs in additional formats such as PDF
-# formats:
-#    - pdf
-
-# Optionally declare the Python requirements required to build your docs
+  configuration: docs/source/conf.py

pyproject.toml

@@ -7,7 +7,7 @@ enable = true
 
 [tool.poetry]
 name = "brainles_aurora"
-version = "0.0.0" # will be overwritten by poetry-dynamic-versioning but needs to be set
+version = "0.0.0"                                                      # will be overwritten by poetry-dynamic-versioning but needs to be set
 description = "Segmentation models for cancer metastasis in brain MR."
 license = "AGPL-3.0"
 
@@ -28,9 +28,9 @@ repository = "https://github.com/BrainLesion/AURORA"
 #documentation = ""
 
 classifiers = [
-    "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: GNU Affero General Public License v3",
-    "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: GNU Affero General Public License v3",
+  "Operating System :: OS Independent",
 ]
 
 # Add the package.exclude field here
@@ -47,7 +47,7 @@ numpy = ">=1.23.0"
 # utils
 tqdm = "^4.64.1"
 path = "^16.2.0"
-requests =">=2.0.0"
+requests = ">=2.0.0"
 rich = ">=13.0.0"
 
 [tool.poetry.dev-dependencies]
@@ -57,7 +57,7 @@ pytest = "^6.2"
 optional = true
 
 [tool.poetry.group.docs.dependencies]
-Sphinx  = ">=7.0.0"
+Sphinx = ">=7.0.0"
 sphinx-copybutton = ">=0.5.2"
 sphinx-rtd-theme = ">=1.3.0"
 myst-parser = ">=2.0.0"