Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use the right default value for include_notebooks #346

Merged
merged 1 commit into from
Jan 3, 2024

Conversation

delucchi-cmu
Copy link
Contributor

@delucchi-cmu delucchi-cmu commented Dec 22, 2023

Change Description

This is a silly thing -

If you said "no" to include_docs, we didn't ask the question for include_notebooks. And so we don't record an answer for include_notebooks and the default answer from the copier.yml file is used in all places (which was True).

This sets the default according to the answer from the include_docs: if we're not including docs, then don't include notebooks; if we're including docs, default to also including notebooks.

Nearly all of the jinja in the rest of the template was doing the right thing, assuming you have correct values for include_docs and include_notebooks.

Closes #332

Checklist

  • This PR is meant for the lincc-frameworks/python-project-template repo and not a downstream one instead.
  • This change is linked to an open issue
  • This change includes integration testing, or is small enough to be covered by existing tests

Copy link
Collaborator

@drewoldag drewoldag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Thank you!

@delucchi-cmu delucchi-cmu merged commit 0aebaac into main Jan 3, 2024
16 checks passed
@delucchi-cmu delucchi-cmu deleted the issue/332/docs branch January 3, 2024 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sphinx included when docs=False
2 participants