From 5765422758568a2a77ff3fd29b0cdbaf99b1386a Mon Sep 17 00:00:00 2001 From: Drew Oldag Date: Fri, 7 Apr 2023 15:30:11 -0700 Subject: [PATCH] Added a comment about keeping dependencies in sync between pyproject.toml and docs/requirements.txt. --- python-project-template/pyproject.toml.jinja | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/python-project-template/pyproject.toml.jinja b/python-project-template/pyproject.toml.jinja index 68569617..b3e57779 100644 --- a/python-project-template/pyproject.toml.jinja +++ b/python-project-template/pyproject.toml.jinja @@ -41,8 +41,11 @@ dev = [ "mypy", # Used for static type checking of files {%- endif %} {%- if include_notebooks %} + # if you add dependencies here while experimenting in a notebook and you + # want that notebook to render in your documentation, please add the + # dependencies to ./docs/requirements.txt as well. "nbconvert", # Needed for pre-commit check to clear output from Python notebooks - "nbsphinx", # Used to itegrate Python notebooks into Sphinx documentation + "nbsphinx", # Used to integrate Python notebooks into Sphinx documentation "ipython", # Also used in building notebooks into Sphinx "matplotlib", # Used in sample notebook intro_notebook.ipynb "numpy", # Used in sample notebook intro_notebook.ipynb