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

add get_writer signal and unify with get_generators

Browse source 
Fix outdated docs of get_generators to unify.
This commit is contained in:
Ondrej Grover 2014-04-27 14:25:08 +02:00
commit 5a3daae72f
3 changed files with 21 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/plugins.rst
View file

@ -83,9 +83,11 @@ article_generator_finalized article_generator invoked at th
article_generator_write_article article_generator, content invoked before writing each article, the article is passed as content
article_writer_finalized article_generator, writer invoked after all articles and related pages have been written, but before
the article generator is closed.
get_generators generators invoked in Pelican.get_generator_classes,
get_generators pelican object invoked in Pelican.get_generator_classes,
can return a Generator, or several
generator in a tuple or in a list.
generators in a tuple or in a list.
get_writer pelican object invoked in Pelican.get_writer,
can return a custom Writer.
page_generator_context page_generator, metadata
page_generator_preread page_generator invoked before a page is read in PageGenerator.generate_context;
use if code needs to do something before every page is parsed.
@ -200,8 +202,8 @@ Adding a new generator is also really easy. You might want to have a look at
::
def get_generators(generators):
def get_generators(pelican_object):
# define a new generator here if you need to
return generators
return MyGenerator
signals.get_generators.connect(get_generators)