From 9f320b5a03490320bcc847afc9649d80beb5ced1 Mon Sep 17 00:00:00 2001 From: Sigurd Spieckermann Date: Tue, 29 Aug 2023 20:22:05 +0200 Subject: [PATCH 1/3] Instruct to create Python virtual env in `venv` instead of `.venv` directory --- docs/customization.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/customization.md b/docs/customization.md index bb1a9ce5a4c..bd0b436e3ef 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -248,8 +248,8 @@ Next, create a new [Python virtual environment][venv] and [activate][venv-activate] it: ``` -python -m venv .venv -source .venv/bin/activate +python -m venv venv +source venv/bin/activate ``` [venv]: https://docs.python.org/3/library/venv.html From b2991120bb726af39ce2cf82b0e882a5543c2c44 Mon Sep 17 00:00:00 2001 From: Sigurd Spieckermann Date: Tue, 29 Aug 2023 20:23:58 +0200 Subject: [PATCH 2/3] Instruct to run `nodeenv` executable instead of Python module --- docs/customization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/customization.md b/docs/customization.md index bd0b436e3ef..d24879c4203 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -268,7 +268,7 @@ Finally, install the [Node.js] LTS version into the Python virtual environment and install all Node.js dependencies: ``` -python -m nodeenv -p -n lts +nodeenv -p -n lts npm install ``` From 63fdbb15e6f70afbe57ece4eca8397550154c7c9 Mon Sep 17 00:00:00 2001 From: Sigurd Spieckermann Date: Tue, 29 Aug 2023 20:26:49 +0200 Subject: [PATCH 3/3] Instruct to build also theme overrides before submitting a PR --- docs/customization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/customization.md b/docs/customization.md index d24879c4203..c4884fcada7 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -310,7 +310,7 @@ npm run build # (1)! 1. While this command will build all theme files, it will skip the overrides used in Material for MkDocs' own documentation which are not distributed with the theme. If you forked the theme and want to build the overrides - as well, use: + as well, e.g. before submitting a PR with changes, use: ``` npm run build:all