From 69fd25a9aba02efa2cfe319d21264ee5c60ae06f Mon Sep 17 00:00:00 2001 From: delucchi-cmu Date: Fri, 22 Dec 2023 09:56:04 -0500 Subject: [PATCH] Use the right default value for include_notebooks --- copier.yml | 2 +- python-project-template/README.md.jinja | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/copier.yml b/copier.yml index aebddfe..643c0ee 100644 --- a/copier.yml +++ b/copier.yml @@ -98,7 +98,7 @@ include_docs: include_notebooks: help: Do you want to include rendered notebooks in your documentation? type: bool - default: yes + default: "{{ include_docs }}" choices: yes: true no: false diff --git a/python-project-template/README.md.jinja b/python-project-template/README.md.jinja index 566570b..bd3178c 100644 --- a/python-project-template/README.md.jinja +++ b/python-project-template/README.md.jinja @@ -48,7 +48,9 @@ Notes: that a set of tests will be run prior to completing a local commit. For more information, see the Python Project Template documentation on [pre-commit](https://lincc-ppt.readthedocs.io/en/latest/practices/precommit.html) +{%- if include_notebooks %} 3) Install `pandoc` allows you to verify that automatic rendering of Jupyter notebooks into documentation for ReadTheDocs works as expected. For more information, see the Python Project Template documentation on [Sphinx and Python Notebooks](https://lincc-ppt.readthedocs.io/en/latest/practices/sphinx.html#python-notebooks) +{%- endif %}