From 8cda4e763a04b70f4b14f3a16e43e0e8696d6e02 Mon Sep 17 00:00:00 2001
From: Fitz Elliott <fitz@cos.io>
Date: Thu, 14 Aug 2025 16:53:54 -0400
Subject: [PATCH] update readthedocs config and build

---
 docs/conf.py                         |  3 +--
 docs/gettingstarted.rst              | 16 ++++++++--------
 readthedocs.yml                      | 20 +++++++++++++++++---
 waterbutler/providers/s3/provider.py |  3 ++-
 4 files changed, 28 insertions(+), 14 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index 7f628ffed4..8465b3eb20 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -10,7 +10,7 @@
 master_doc = "index"
 
 project = "WaterButler"
-copyright = "2018, Center For Open Science"
+copyright = "2025, Center For Open Science"
 
 
 version = release = __version__
@@ -66,4 +66,3 @@
 if not on_rtd:
     import sphinx_rtd_theme
     html_theme = 'sphinx_rtd_theme'
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst
index 2a1c55bf9d..418885a1e1 100644
--- a/docs/gettingstarted.rst
+++ b/docs/gettingstarted.rst
@@ -4,24 +4,23 @@ Getting Started
 Setting Up
 ----------
 
-Make sure that you are using >= python3.5 and install invoke for your current python3 version.
+Make sure that you are using >= python3.13 and install poetry to manage dependencies.
 
 .. code-block:: bash
 
-    pip install setuptools==37.0.0
-    pip install invoke==0.13.0
+    pip install poetry==2.1.2
 
 Install requirements
 
 .. code-block:: bash
 
-    invoke install
+    poetry install
 
 Or for some nicities (like tests)
 
 .. code-block:: bash
 
-    invoke install --develop
+    poetry install --with dev
 
 
 Start the server
@@ -34,7 +33,7 @@ Start the server
 
 .. code-block:: bash
 
-    invoke server
+    poetry run invoke server
 
 Start the celery worker
 
@@ -44,7 +43,7 @@ Start the celery worker
 
 .. code-block:: bash
 
-    invoke celery
+    poetry run invoke celery
 
 Contributing
 ------------
@@ -67,5 +66,6 @@ Make sure that you already have dev-requirements
 
 .. code-block:: bash
 
-    invoke test
+    poetry install --with dev
+    poetry run invoke test
 
diff --git a/readthedocs.yml b/readthedocs.yml
index a1949e9816..96d92b6574 100644
--- a/readthedocs.yml
+++ b/readthedocs.yml
@@ -1,3 +1,17 @@
-requirements_file: doc-requirements.txt
-python:
-   setup_py_install: true
+version: 2
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+  jobs:
+    post_install:
+      # Install poetry
+      # https://python-poetry.org/docs/#installing-manually
+      - pip install poetry
+      # Install dependencies with 'docs' dependency group
+      # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
+      # 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
+sphinx:
+  configuration: docs/conf.py
diff --git a/waterbutler/providers/s3/provider.py b/waterbutler/providers/s3/provider.py
index b483ac974a..310be5e7d0 100644
--- a/waterbutler/providers/s3/provider.py
+++ b/waterbutler/providers/s3/provider.py
@@ -853,7 +853,8 @@ async def revisions(self, path, **kwargs):
         """Get past versions of the requested key
 
         :param str path: The path to a key
-        :rtype list:
+        :rtype: list
+
         Docs: https://boto3.amazonaws.com/v1/documentation/api/1.28.0/reference/services/s3/client/list_object_versions.html
         """
         await self._check_region()