Merge pull request #191 from janash/rtd-patch

update rtd yaml and requirements file
MolSSI · Jul 23, 2024 · d1bc7ec · d1bc7ec
2 parents 372d4e1 + dd93ef5
commit d1bc7ec
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 18 deletions.
diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py
@@ -72,7 +72,7 @@ def remove_rtd():
     include_rtd = '{{ cookiecutter.include_ReadTheDocs }}'
     if include_rtd == "n":
         rtd_env = os.path.join("docs", "requirements.yaml")
-        os.remove('readthedocs.yml')
+        os.remove('.readthedocs.yaml')
         os.remove(rtd_env)
 
 

diff --git a/{{cookiecutter.repo_name}}/.readthedocs.yaml b/{{cookiecutter.repo_name}}/.readthedocs.yaml
@@ -0,0 +1,9 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "mambaforge-22.9"
+
+conda:
+  environment: docs/requirements.yaml
diff --git a/{{cookiecutter.repo_name}}/docs/requirements.yaml b/{{cookiecutter.repo_name}}/docs/requirements.yaml
@@ -1,14 +1,14 @@
 name: docs_{{cookiecutter.project_name}}
 channels:
-{% if cookiecutter.dependency_source == 'Prefer conda-forge over the default anaconda channel with pip fallback' %}
+{% if cookiecutter.dependency_source == 'Prefer conda-forge with pip fallback' %}
   - conda-forge
 {% endif %}
   - defaults
 dependencies:
     # Base depends
   - python
   - pip
-  {% if cookiecutter.dependency_source == 'Prefer conda-forge over the default anaconda channel with pip fallback' %}
+  {% if cookiecutter.dependency_source == 'Prefer conda-forge with pip fallback' %}
   - pydata-sphinx-theme
   - sphinx-design
   - sphinx-copybutton

diff --git a/{{cookiecutter.repo_name}}/readthedocs.yml b/{{cookiecutter.repo_name}}/readthedocs.yml