docs: standardize .reathedocs.yml to .readthedocs.yaml (#361)

* Typo fix from .reathedocs.yml to .readthedocs.yaml * style: pre-commit fixes * fix: move remaining readthedocs to yaml ext Signed-off-by: Henry Schreiner <[email protected]> --------- Signed-off-by: Henry Schreiner <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Henry Schreiner <[email protected]>
scientific-python · Jan 24, 2024 · 0bfc28b · 0bfc28b
1 parent 4aaa0c4
commit 0bfc28b
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/docs/pages/guides/docs.md b/docs/pages/guides/docs.md
@@ -59,7 +59,7 @@ from cog_helpers import code_fence, render_cookie, Matcher
 with render_cookie() as package:
     docs_conf_py = package.joinpath("docs/conf.py").read_text(encoding="utf-8").strip()
     docs_index_md = package.joinpath("docs/index.md").read_text(encoding="utf-8").strip()
-    readthedocs_yaml = package.joinpath(".readthedocs.yml").read_text(encoding="utf-8").strip()
+    readthedocs_yaml = package.joinpath(".readthedocs.yaml").read_text(encoding="utf-8").strip()
     noxfile = Matcher.from_file(package / "noxfile.py")
 ]]] -->
 <!-- [[[end]]] -->
@@ -235,7 +235,8 @@ plugins and try to build against an uninstalled version of your project.
 ### .readthedocs.yaml
 
 In order to use <https://readthedocs.org> to build, host, and preview your
-documentation, you must have a `.reathedocs.yml` file {% rr RTD100 %} like this:
+documentation, you must have a `.readthedocs.yaml` file {% rr RTD100 %} like
+this:
 
 <!-- [[[cog
 with code_fence("yaml"):

diff --git a/...kiecutter.project_name}}/.readthedocs.yml → ...iecutter.project_name}}/.readthedocs.yaml b/...kiecutter.project_name}}/.readthedocs.yml → ...iecutter.project_name}}/.readthedocs.yaml
diff --git a/...t_name}}/{% if cookiecutter.backend in ['setuptools','pybind11'] %}MANIFEST.in{% endif %} b/...t_name}}/{% if cookiecutter.backend in ['setuptools','pybind11'] %}MANIFEST.in{% endif %}
@@ -2,5 +2,5 @@ graft src
 graft tests
 
 include LICENSE README.md pyproject.toml setup.py setup.cfg .git_archival.txt
-exclude .readthedocs.yml
+exclude .readthedocs.yaml
 global-exclude __pycache__ *.py[cod] .venv