Skip to content

Commit 0bfc28b

Browse files
tkoyama010pre-commit-ci[bot]henryiii
authored
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]>
1 parent 4aaa0c4 commit 0bfc28b

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

docs/pages/guides/docs.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ from cog_helpers import code_fence, render_cookie, Matcher
5959
with render_cookie() as package:
6060
docs_conf_py = package.joinpath("docs/conf.py").read_text(encoding="utf-8").strip()
6161
docs_index_md = package.joinpath("docs/index.md").read_text(encoding="utf-8").strip()
62-
readthedocs_yaml = package.joinpath(".readthedocs.yml").read_text(encoding="utf-8").strip()
62+
readthedocs_yaml = package.joinpath(".readthedocs.yaml").read_text(encoding="utf-8").strip()
6363
noxfile = Matcher.from_file(package / "noxfile.py")
6464
]]] -->
6565
<!-- [[[end]]] -->
@@ -235,7 +235,8 @@ plugins and try to build against an uninstalled version of your project.
235235
### .readthedocs.yaml
236236

237237
In order to use <https://readthedocs.org> to build, host, and preview your
238-
documentation, you must have a `.reathedocs.yml` file {% rr RTD100 %} like this:
238+
documentation, you must have a `.readthedocs.yaml` file {% rr RTD100 %} like
239+
this:
239240

240241
<!-- [[[cog
241242
with code_fence("yaml"):
File renamed without changes.

{{cookiecutter.project_name}}/{% if cookiecutter.backend in ['setuptools','pybind11'] %}MANIFEST.in{% endif %}

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ graft src
22
graft tests
33

44
include LICENSE README.md pyproject.toml setup.py setup.cfg .git_archival.txt
5-
exclude .readthedocs.yml
5+
exclude .readthedocs.yaml
66
global-exclude __pycache__ *.py[cod] .venv

0 commit comments

Comments
 (0)