Merge pull request #50 from dhellmann/rtd-modernization

docs: add read the docs configuration file

Author: dhellmann

.github/workflows/test.yml

@@ -16,7 +16,6 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - 3.7
           - 3.8
           - 3.9
           - "3.10"
@@ -139,10 +138,8 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          # Pin this low because RTD doesn't seem to adopt new
-          # versions quickly and this ensures we don't have a
-          # dependency problem with importlib.metadata.
-          python-version: "3.7"
+          # Pin this to the same version used on in .readthedocs.yaml
+          python-version: "3.11"
 
       - name: Install dependencies
         run: python -m pip install tox

.mergify.yml

@@ -28,6 +28,7 @@ pull_request_rules:
           - "title~=^docs:"
           - "files~=docs"
           - "files~=.rst$"
+          - "files~=.readthedocs.yaml$"
     actions:
       label:
         add:

.readthedocs.yaml

@@ -0,0 +1,12 @@
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.11"
+
+python:
+  # Install our python package before building the docs
+  install:
+    - method: pip
+      path: .

docs/source/conf.py

@@ -14,15 +14,7 @@
 
 import datetime
 
-# Try to import the version from our package, but if that fails
-# because of the way the RTD build works fall back to at least using
-# the git tag information.
-try:
-    from virtualenvwrapper.version import version
-except ImportError:
-    import subprocess
-    p = subprocess.run(['git', 'describe'], stdout=subprocess.PIPE)
-    version = p.stdout.decode('utf-8').strip()
+import virtualenvwrapper.version
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -60,7 +52,7 @@
 # built documents.
 #
 # The short X.Y version.
-# version = "SEE IMPORTS ABOVE"
+version = virtualenvwrapper.version.version
 # The full version, including alpha/beta/rc tags.
 release = version
 

pyproject.toml

@@ -13,7 +13,6 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
@@ -28,7 +27,7 @@ dynamic = ["version"]
 keywords = ["virtualenv"]
 license = {text = "MIT"}
 readme = "README.txt"
-requires-python = ">=3.7"
+requires-python = ">=3.8"
 
 dependencies = [
     "virtualenv",