From 0bfc28b9eed761077be7188e05b3ee531ad41f60 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Thu, 25 Jan 2024 03:59:15 +0900 Subject: [PATCH] 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 --------- Signed-off-by: Henry Schreiner Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Henry Schreiner --- docs/pages/guides/docs.md | 5 +++-- .../{.readthedocs.yml => .readthedocs.yaml} | 0 ...end in ['setuptools','pybind11'] %}MANIFEST.in{% endif %} | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) rename {{cookiecutter.project_name}}/{.readthedocs.yml => .readthedocs.yaml} (100%) diff --git a/docs/pages/guides/docs.md b/docs/pages/guides/docs.md index 35642e5d..6e3cddad 100644 --- 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") ]]] --> @@ -235,7 +235,8 @@ plugins and try to build against an uninstalled version of your project. ### .readthedocs.yaml In order to use 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: