Added the .readthedocs.yml file, added tests and adjusted copier.yml and conftest.py

Author: h-chmeruk

copier.yml

@@ -90,8 +90,9 @@ dependencies:
     type: str
     help: |
         Enter the dependencies of this project, separate them with commas and do not leave any
-        spaces between them. These dependencies will be included in the pyproject.toml file.
-    default: "numpy,scipy"
+        spaces between them. These dependencies will be included in the pyproject.toml 
+        and in the .readthedocs.yml files.
+    default: "numpy,scipy,libsndfile1"
 
 valid_python_versions:
   when: false
@@ -100,6 +101,12 @@ valid_python_versions:
     {% set min_index = python_versions.index(minimum_python_version) %}
     {{ python_versions[min_index:] }}
 
+default_python_version:
+  when: false
+  type: yaml
+  default: >
+    {{ python_versions[-1] }}
+
 pypi_license_classifiers_list:
   when: false
   type: yaml

template/.readthedocs.yml.jinja

@@ -0,0 +1,32 @@
+# .readthedocs.yml
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: {{ default_python_version }}
+  {% if 'libsndfile1' in dependencies -%}
+  apt_packages:
+    - libsndfile1
+  {%- endif %}
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - pdf
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - method: pip
+      path: ".[docs]"

tests/conftest.py

@@ -11,6 +11,7 @@ def copier_project_defaults():
         "license": "MIT",
         "copyright_statement": "2025, The pyfar developers",
         "project_short_description": "my_project_short_description",
+        "python_versions": "['3.9', '3.10', '3.11', '3.12', '3.13', '3.14']",
         }
 
 @pytest.fixture(scope="session")

tests/test_copier.py

@@ -16,6 +16,7 @@ def test_project_folder(default_project):
     "my_project/my_project.py",
     "HISTORY.rst",
     ".github/workflows/check_modified_history.yml",
+    ".readthedocs.yml",
 ])
 def test_generated_file_exists(default_project, file_name):
     assert default_project.project_dir.joinpath(file_name).exists()
@@ -120,3 +121,13 @@ def test_content_history(default_project):
                                     "HISTORY.rst").read_text()
     desired = f"0.1.0 ({date.today().strftime('%Y-%m-%d')})"
     assert desired in content
+
+
+@pytest.mark.parametrize("desired", [
+    '- libsndfile1',
+    "python: 3.14",
+])
+def test_content_readthedocs(default_project, desired):
+    content = default_project.project_dir.joinpath(
+                                    ".readthedocs.yml").read_text()
+    assert desired in content