From 64380df77a5dde47cd4e9dd6c3feeb94f9517adc Mon Sep 17 00:00:00 2001 From: Alex Wolf Date: Thu, 7 Jul 2022 14:37:10 +0200 Subject: [PATCH 1/3] :green_heart: Fix pyproject.toml --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 0880d28..6878fe6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -31,7 +31,7 @@ preview = true testpaths = [ "tests", "docs/guides", - "docs/tutorial", + "docs/tutorials", ] [tool.coverage.run] From 6f8e482e858d4fd732096b61efba793da494c4a8 Mon Sep 17 00:00:00 2001 From: Alex Wolf Date: Thu, 7 Jul 2022 14:39:37 +0200 Subject: [PATCH 2/3] :memo: Add more explanation --- docs/index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/index.md b/docs/index.md index b122fcf..c8ecf7a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,6 +3,11 @@ :end-line: 1 ``` +```{note} + +If you aren't the person who used the cookiecutter, make sure you init `pre-commit install` and `gitmoji -i` on the CLI before starting to work on this repository! +``` + You'll probably not need all the different types of directories here. Just make sure what each of them is supposed to provide. From b681de8073bf5c1566abc53977bd6411b7d01a97 Mon Sep 17 00:00:00 2001 From: Alex Wolf Date: Thu, 7 Jul 2022 14:44:44 +0200 Subject: [PATCH 3/3] :memo: Add a note --- docs/notes/YYYY-MM-DD-my-design-choice.ipynb | 43 ++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/notes/YYYY-MM-DD-my-design-choice.ipynb diff --git a/docs/notes/YYYY-MM-DD-my-design-choice.ipynb b/docs/notes/YYYY-MM-DD-my-design-choice.ipynb new file mode 100644 index 0000000..1ad4b0d --- /dev/null +++ b/docs/notes/YYYY-MM-DD-my-design-choice.ipynb @@ -0,0 +1,43 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "id": "1d7b3b73-75f9-468d-8783-873ebadcab9b", + "metadata": {}, + "source": [ + "# My design choice" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "97ec6631-8473-4a2d-b488-def921bb83de", + "metadata": {}, + "outputs": [], + "source": [ + "from nbproject import header" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.9.7" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +}