From 3248a900da4e0839cbd93918d29a45ed408499ee Mon Sep 17 00:00:00 2001 From: Billy Jacobson Date: Fri, 12 Jun 2020 12:39:23 -0400 Subject: [PATCH 1/5] update authoring guide --- AUTHORING_GUIDE.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/AUTHORING_GUIDE.md b/AUTHORING_GUIDE.md index 69b063bf2d4..1dacb4db8d3 100644 --- a/AUTHORING_GUIDE.md +++ b/AUTHORING_GUIDE.md @@ -483,7 +483,13 @@ __Note:__ As a temporary workaround, each project currently uses first `noxfile-template.py` found in a parent folder above the current sample. In order to simulate this locally, you need to copy + rename the parent `noxfile-template.py` as `noxfile.py` in the folder of the project you want to -run tests. +run tests: + +```console +cp noxfile-template.py PRODUCT/noxfile.py +cd PRODUCT/ +nox -s lint +``` To use nox, install it globally with `pip`: From 864d758d507af335b986e08b8ffd3d5dbbe80666 Mon Sep 17 00:00:00 2001 From: Billy Jacobson Date: Fri, 12 Jun 2020 12:44:02 -0400 Subject: [PATCH 2/5] specifying start directory --- AUTHORING_GUIDE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/AUTHORING_GUIDE.md b/AUTHORING_GUIDE.md index 1dacb4db8d3..3653f5b2c90 100644 --- a/AUTHORING_GUIDE.md +++ b/AUTHORING_GUIDE.md @@ -486,6 +486,7 @@ order to simulate this locally, you need to copy + rename the parent run tests: ```console +cd python-docs-samples cp noxfile-template.py PRODUCT/noxfile.py cd PRODUCT/ nox -s lint From 67f976feba39e151dccb2347113879d92efcce86 Mon Sep 17 00:00:00 2001 From: Billy Jacobson Date: Mon, 22 Jun 2020 18:23:53 -0400 Subject: [PATCH 3/5] Add information about subdirectories --- AUTHORING_GUIDE.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/AUTHORING_GUIDE.md b/AUTHORING_GUIDE.md index 91d71a25ddb..0b2b763d480 100644 --- a/AUTHORING_GUIDE.md +++ b/AUTHORING_GUIDE.md @@ -489,6 +489,16 @@ cp noxfile-template.py PRODUCT/noxfile.py cd PRODUCT/ nox -s lint ``` +or if you use subdirectories that contain `requirements.txt`, you'll need to +copy it into each subdirectory and run lint from there: + +```console +cd python-docs-samples +cp noxfile-template.py PRODUCT/EXAMPLE/noxfile.py +cd PRODUCT/EXAMPLE/ +nox -s lint +``` + To use nox, install it globally with `pip`: From 649d92fe7e12e73e47ac12d2684cd96a2233b48d Mon Sep 17 00:00:00 2001 From: Billy Jacobson Date: Mon, 22 Jun 2020 19:59:18 -0400 Subject: [PATCH 4/5] Update AUTHORING_GUIDE.md Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com> --- AUTHORING_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AUTHORING_GUIDE.md b/AUTHORING_GUIDE.md index 0b2b763d480..afdcc7050fa 100644 --- a/AUTHORING_GUIDE.md +++ b/AUTHORING_GUIDE.md @@ -480,7 +480,7 @@ as well as automated README generation. __Note:__ As a temporary workaround, each project currently uses first `noxfile-template.py` found in a parent folder above the current sample. In order to simulate this locally, you need to copy + rename the parent -`noxfile-template.py` as `noxfile.py` in the folder of the project you want to +`noxfile-template.py` as `noxfile.py` in the folder of the project (containing the `requirements.txt` for the file) you want to run tests: ```console From a033f5dbab8f6fa957edbc05a8a43b0ed141bab9 Mon Sep 17 00:00:00 2001 From: Billy Jacobson Date: Mon, 22 Jun 2020 19:59:30 -0400 Subject: [PATCH 5/5] Update AUTHORING_GUIDE.md Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com> --- AUTHORING_GUIDE.md | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/AUTHORING_GUIDE.md b/AUTHORING_GUIDE.md index afdcc7050fa..1ef11b86069 100644 --- a/AUTHORING_GUIDE.md +++ b/AUTHORING_GUIDE.md @@ -481,22 +481,10 @@ __Note:__ As a temporary workaround, each project currently uses first `noxfile-template.py` found in a parent folder above the current sample. In order to simulate this locally, you need to copy + rename the parent `noxfile-template.py` as `noxfile.py` in the folder of the project (containing the `requirements.txt` for the file) you want to -run tests: - ```console cd python-docs-samples -cp noxfile-template.py PRODUCT/noxfile.py -cd PRODUCT/ -nox -s lint -``` -or if you use subdirectories that contain `requirements.txt`, you'll need to -copy it into each subdirectory and run lint from there: - -```console -cd python-docs-samples -cp noxfile-template.py PRODUCT/EXAMPLE/noxfile.py -cd PRODUCT/EXAMPLE/ -nox -s lint +cp noxfile-template.py PATH/TO/YOUR/PROJECT/noxfile.py +cd PATH/TO/YOUR/PROJECT/ ```