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

Merge branch 'main' into fix-auto-reload

Browse source
This commit is contained in:
Justin Mayer 2025-01-14 12:52:19 +01:00 • committed by GitHub
commit 9e3e1a5c23
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 120 additions and 16 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
signal is emitted.
If multiple plugins connect to the same signal, plugins will be executed in the
order they are connected. With ``PLUGINS`` setting, order will be as defined in
the setting. If you rely on auto-discovered namespace plugins, no ``PLUGINS``
setting, they will be connected in the same order they are discovered (same
order as ``pelican-plugins`` output). If you want to specify the order
explicitly, disable auto-discovery by defining ``PLUGINS`` in the desired order.
If multiple plugins connect to the same signal, plugins will be invoked in the
order they are registered. When the ``PLUGINS`` setting is defined, plugin
invocation order will be the order in which the plugins are listed in the
``PLUGINS`` setting. If you rely on auto-discovered namespace plugins and have
no ``PLUGINS`` setting defined, plugins will be invoked in the same order that
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
--------------------------

9
docs/settings.rst
View file

@ -292,7 +292,14 @@ Basic settings
A list of tags for Typogrify to ignore. By default Typogrify will ignore
``pre`` and ``code`` tags. This requires that Typogrify version 2.0.4 or
later is installed
later is installed.
.. data:: TYPOGRIFY_OMIT_FILTERS = []
A list of Typogrify filters to skip. Allowed values are: ``'amp'``,
``'smartypants'``, ``'caps'``, ``'initial_quotes'``, ``'widont'``. By
default, no filter is omitted (in other words, all filters get applied). This
setting requires that Typogrify version 2.1.0 or later is installed.
.. data:: TYPOGRIFY_DASHES = 'default'