Correctly configure extras for ReadTheDocs

repo-helper · Apr 16, 2021 · d1f8b7b · d1f8b7b
1 parent d5e93de
commit d1f8b7b
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/repo_helper/files/docs.py b/repo_helper/files/docs.py
@@ -199,7 +199,7 @@ def make_rtfd(repo_path: pathlib.Path, templates: jinja2.Environment) -> List[st
 
 	file = PathPlus(repo_path / ".readthedocs.yml")
 
-	docs_dir = PathPlus(repo_path / templates.globals['docs_dir'])
+	docs_dir = PathPlus(repo_path / templates.globals["docs_dir"])
 
 	sphinx_config = {
 			"builder": "html",
@@ -220,7 +220,7 @@ def make_rtfd(repo_path: pathlib.Path, templates: jinja2.Environment) -> List[st
 		install_config.append({
 				"method": "pip",
 				"path": '.',
-				"extra_requirements": templates.globals["tox_testenv_extras"],
+				"extra_requirements": [templates.globals["tox_testenv_extras"]],
 				})
 
 	else:

diff --git a/tests/test_files/test_docs_/test_make_rtfd_case_1.yml b/tests/test_files/test_docs_/test_make_rtfd_case_1.yml
@@ -15,4 +15,5 @@ python:
    - requirements: doc-source/requirements.txt
    - method: pip
      path: .
-     extra_requirements: all
+     extra_requirements:
+      - all
diff --git a/tests/test_files/test_docs_/test_make_rtfd_case_2.yml b/tests/test_files/test_docs_/test_make_rtfd_case_2.yml
@@ -16,4 +16,5 @@ python:
    - requirements: hello_world/submodule/requirements.txt
    - method: pip
      path: .
-     extra_requirements: all
+     extra_requirements:
+      - all