github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Clarify namespace plugin loading order

Browse source
This commit is contained in:
Justin Mayer 2025-01-14 12:49:34 +01:00
commit 8a1c55ed07
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/plugins.rst
View file

@ -94,12 +94,14 @@ which you map the signals to your plugin logic. Let's take a simple example::
your ``register`` callable or they will be garbage-collected before the your ``register`` callable or they will be garbage-collected before the
signal is emitted. signal is emitted.
If multiple plugins connect to the same signal, plugins will be executed in the If multiple plugins connect to the same signal, plugins will be invoked in the
order they are connected. With ``PLUGINS`` setting, order will be as defined in order they are registered. When the ``PLUGINS`` setting is defined, plugin
the setting. If you rely on auto-discovered namespace plugins, no ``PLUGINS`` invocation order will be the order in which the plugins are listed in the
setting, they will be connected in the same order they are discovered (same ``PLUGINS`` setting. If you rely on auto-discovered namespace plugins and have
order as ``pelican-plugins`` output). If you want to specify the order no ``PLUGINS`` setting defined, plugins will be invoked in the same order that
explicitly, disable auto-discovery by defining ``PLUGINS`` in the desired order. they are discovered (the same order as listed in the output of the
``pelican-plugins`` command). If you want to specify the order explicitly,
disable auto-discovery by defining ``PLUGINS`` in the desired order.
Namespace plugin structure Namespace plugin structure
-------------------------- --------------------------