@@ -69,7 +69,8 @@ with render_cookie(backend="hatch", docs="sphinx") as package:
6969 docs_index_md = package.joinpath("docs/index.md").read_text(encoding="utf-8").strip()
7070 readthedocs_yaml = package.joinpath(".readthedocs.yaml").read_text(encoding="utf-8").strip()
7171 noxfile = Matcher.from_file(package / "noxfile.py")
72- with render_cookie(backend="hatch", docs="sphinx") as package:
72+ with render_cookie(backend="hatch", docs="mkdocs") as package:
73+ mkdocs_conf_yaml = package.joinpath("mkdocs.yml").read_text(encoding="utf-8").strip()
7374 noxfile_mkdocs = Matcher.from_file(package / "noxfile.py")
7475 readthedocs_yaml_mkdocs = package.joinpath(".readthedocs.yaml").read_text(encoding="utf-8").strip()
7576]]] -->
@@ -304,12 +305,18 @@ example configuration now.
304305
305306Here's the whole file for completeness. We'll break it into sections underneath.
306307
308+ <!-- [[[cog
309+ with code_fence("yaml"):
310+ print(mkdocs_conf_yaml)
311+ ]]] -->
312+ <!-- prettier-ignore-start -->
307313``` yaml
308- site_name : some_project
309- site_url : https://some_project.readthedocs.io/
310- site_author : " Bruce Wayne"
311- repo_name : " wayne_industries/some_project"
312- repo_url : " https://github.com/wayne_industries/some_project"
314+ site_name : package
315+ site_url : https://package.readthedocs.io/
316+ site_author : " My Name"
317+
318+ repo_name : " org/package"
319+ repo_url : " https://github.com/org/package"
313320
314321theme :
315322 name : material
357364 - Home : index.md
358365 - Python API : api.md
359366` ` `
367+ <!-- prettier-ignore-end -->
368+ <!-- [[[end]]] -->
360369
361370First, the basic site metadata contains authors, repository details, URLs, etc:
362371
@@ -605,7 +614,7 @@ def docs(session: nox.Session) -> None:
605614 """
606615
607616 doc_deps = nox.project.dependency_groups(PROJECT, "docs")
608- session.install("{% if cookiecutter.backend != "mesonpy" %}-e{% endif %} .", *doc_deps)
617+ session.install("-e .", *doc_deps)
609618 session.run("mkdocs", "serve", "--clean")
610619` ` `
611620<!-- prettier-ignore-end -->
0 commit comments