Skip to content

Commit

Permalink
Document the pre_composition signal.
Browse files Browse the repository at this point in the history
  • Loading branch information
mblayman committed Jun 7, 2015
1 parent 1521a38 commit 5ce2b8b
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/signals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,22 @@ will be called with:
* ``source_file`` - The absolute path to the file containing front matter.
* ``frontmatter`` - The front matter dictionary that was loaded.

pre_composition
----------------

``pre_composition`` fires before processing the entire site. When the
watcher is running (see :ref:`devserver`), the signal will fire before
handling any file or directory change.
Any handler function that connects to the signal will be called with:

* ``director`` - The director instance that processed the site.

post_composition
----------------

``post_composition`` fires after processing the entire site. When the
watcher is running (see :ref:`devserver`), the signal will fire after
any file or directory change. Any handler function that connects to the
signal will be called with:
handling any file or directory change.
Any handler function that connects to the signal will be called with:

* ``director`` - The director instance that processed the site.

0 comments on commit 5ce2b8b

Please sign in to comment.