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: Reflow to 79 char line limit

Browse source
This commit is contained in:
MinchinWeb 2018-11-02 20:53:15 -06:00
commit f595741b8e
16 changed files with 481 additions and 460 deletions
Download patch file Download diff file Expand all files Collapse all files

31
docs/plugins.rst
View file

@ -22,11 +22,10 @@ Alternatively, another method is to import them and add them to the list::
.. note::
When experimenting with different plugins (especially the ones that
deal with metadata and content) caching may interfere and the
changes may not be visible. In such cases disable caching with
``LOAD_CONTENT_CACHE = False`` or use the ``--ignore-cache``
command-line switch.
When experimenting with different plugins (especially the ones that deal
with metadata and content) caching may interfere and the changes may not be
visible. In such cases disable caching with ``LOAD_CONTENT_CACHE = False``
or use the ``--ignore-cache`` command-line switch.
If your plugins are not in an importable path, you can specify a list of paths
via the ``PLUGIN_PATHS`` setting. As shown in the following example, paths in
@ -126,17 +125,17 @@ feed_written path, context, feed invoked each
.. warning::
Avoid ``content_object_init`` signal if you intend to read ``summary``
or ``content`` properties of the content object. That combination can
result in unresolved links when :ref:`ref-linking-to-internal-content`
(see `pelican-plugins bug #314`_). Use ``_summary`` and ``_content``
properties instead, or, alternatively, run your plugin at a later
stage (e.g. ``all_generators_finalized``).
Avoid ``content_object_init`` signal if you intend to read ``summary`` or
``content`` properties of the content object. That combination can result in
unresolved links when :ref:`ref-linking-to-internal-content` (see
`pelican-plugins bug #314`_). Use ``_summary`` and ``_content`` properties
instead, or, alternatively, run your plugin at a later stage (e.g.
``all_generators_finalized``).
.. note::
After Pelican 3.2, signal names were standardized. Older plugins
may need to be updated to use the new names:
After Pelican 3.2, signal names were standardized. Older plugins may need
to be updated to use the new names:
========================== ===========================
Old name New name
@ -162,9 +161,9 @@ How to create a new reader
--------------------------
One thing you might want is to add support for your very own input format.
While it might make sense to add this feature in Pelican core, we
wisely chose to avoid this situation and instead have the different readers
defined via plugins.
While it might make sense to add this feature in Pelican core, we wisely chose
to avoid this situation and instead have the different readers defined via
plugins.
The rationale behind this choice is mainly that plugins are really easy to
write and don't slow down Pelican itself when they're not active.