From fcb73ad095f1d2851f9819df69079ceec0a9e6c7 Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Sun, 19 Dec 2021 15:41:31 +0000 Subject: [PATCH] Clarify docs for writing plugins If the beetsplug directory itself is added to the python path then python does not see the plugin as part of the beetsplug namespace. --- docs/dev/plugins.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/dev/plugins.rst b/docs/dev/plugins.rst index 3956aa760..49123b8a0 100644 --- a/docs/dev/plugins.rst +++ b/docs/dev/plugins.rst @@ -36,7 +36,8 @@ found therein. Here's a skeleton of a plugin file:: Once you have your ``BeetsPlugin`` subclass, there's a variety of things your plugin can do. (Read on!) -To use your new plugin, make sure your ``beetsplug`` directory is in the Python +To use your new plugin, make sure the directory that contains your +``beetsplug`` directory is in the Python path (using ``PYTHONPATH`` or by installing in a `virtualenv`_, for example). Then, as described above, edit your ``config.yaml`` to include ``plugins: myawesomeplugin`` (substituting the name of the Python module