update docs: Mention that shell should be restarted if want to use wa…

…kepy CLI command (#321) Mention that to get the wakepy CLI command working, one might need to restart the shell / terminal application
fohrloop · May 28, 2024 · 076e617 · 076e617
1 parent 05821df
commit 076e617
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/source/cli-api.md b/docs/source/cli-api.md
@@ -23,4 +23,11 @@ options:
                            is used as a default if no modes are selected.
   -p, --presentation       Presentation mode; inhibit automatic sleep, screensaver and
                            screenlock
-```
+```
+
+
+````{admonition} Command "wakepy" not found?
+:class: note
+
+If you just installed `wakepy`, you might need to restart shell / terminal application to make added to the PATH.
+````
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -58,6 +58,8 @@ Wakepy supports CPython 3.7 to 3.13, and may be installed with
 pip install wakepy
 ```
 
+To get the `wakepy` [CLI command](#cli-api) working, you might need to restart the shell / terminal application.
+
 ## Why wakepy?
 Here's some reasons why you might want to consider using wakepy: