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

Document the pelican-plugins command

Browse source
This commit is contained in:
Justin Mayer 2020-05-26 15:18:24 +02:00
commit 9db937e581
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/plugins.rst
View file

@ -9,10 +9,12 @@ features to Pelican without having to directly modify the Pelican core.
How to use plugins How to use plugins
================== ==================
Starting with version 5.0, Pelican moved to a new plugin structure utilizing Starting with version 4.5, Pelican moved to a new plugin structure utilizing
namespace packages. Plugins supporting this structure will install under the namespace packages. Plugins supporting this structure will install under the
namespace package ``pelican.plugins`` and can be automatically discovered namespace package ``pelican.plugins`` and can be automatically discovered
by Pelican. by Pelican. To see a list of plugins that are active in your environment, run::
pelican-plugins
If you leave the ``PLUGINS`` setting as default (``None``), Pelican will then If you leave the ``PLUGINS`` setting as default (``None``), Pelican will then
collect the namespace plugins and register them. If on the other hand you collect the namespace plugins and register them. If on the other hand you
@ -20,7 +22,7 @@ specify a ``PLUGINS`` settings as a list of plugins, this autodiscovery will
be disabled and only listed plugins will be registered and you will have to be disabled and only listed plugins will be registered and you will have to
explicitly list the namespace plugins as well. explicitly list the namespace plugins as well.
If you are using ``PLUGINS`` setting, you can specify plugins in two ways. If you are using the ``PLUGINS`` setting, you can specify plugins in two ways.
The first method specifies plugins as a list of strings. Namespace plugins can The first method specifies plugins as a list of strings. Namespace plugins can
be specified either by their full names (``pelican.plugins.myplugin``) or by be specified either by their full names (``pelican.plugins.myplugin``) or by
their short names (``myplugin``):: their short names (``myplugin``)::