pelican
pelican copied to clipboard
No description to explain when some symbols are generated
- [x] I have searched the issues (including closed ones) and believe that this is not a duplicate.
Issue
The list of signals at https://docs.getpelican.com/en/latest/plugins.html#list-of-signals does not have descriptions for the following signals:
- initialized
- article_generator_context
- page_generator_context
- static_generator_context
It is not obvious exactly when these signals occur.
Off-topic. Compiled a list of signal in actual execution order (based on various Python traces). Didn't know where to put it.
# All signals are listed here as of Pelican v4.9.1
# signals.get_generators.connect()
# signals.readers_init()
# signals.generator_init()
signals.article_generator_init.connect(mp_article_init)
# signals.readers_init()
# signals.readers_init()
# signals.generator_init()
# signals.page_generator_init()
# signals.readers_init()
# signals.generator_init()
# signals.readers_init()
# signals.generator_init()
# signals.static_generator_init()
signals.article_generator_preread.connect(mp_article_preread)
signals.article_generator_context.connect(mp_article_context)
signals.content_object_init.connect(mp_content_object_init)
signals.article_generator_pretaxonomy.connect(mp_article_pretaxonomy)
signals.article_generator_finalized.connect(mp_article_finalized)
# signals.page_generator_preread.connect(mp_page_preread)
# signals.page_generator_context.connect(mp_page_context)
# signals.content_object_init.connect(mp_content_object_init)
# signals.page_generator_finalized.connect(mp_page_finalized)
# signals.static_generator_preread.connect(mp_static_preread)
# signals.static_generator_context.connect(mp_static_context)
# signals.content_object_init.connect(mp_content_object_init)
# signals.static_generator_finalized.connect(mp_static_finalized)
# signals.all_generators_finalized.connect(mp_all_generators_finalized)
# signals.get_writers()
# signals.feed_generated()
# signals.feed_written()
signals.article_generator_write_article.connect(mp_article_write)
# signals.content_written()
# signals.article_writer_finalized.connect(mp_article_write)
# signals.page_generator_write_page.connect(mp_article_write)
# signals.content_written()
# signals.page_writer_finalized()
# signals.content_written()
# signals.pelican_finalized()
EDIT: It is now here: https://github.com/egberts/pelican/wiki/Plugin-Development