tutor/docs/reference/api/hooks/catalog.rst

.. _hooks_catalog:

=============
Hooks catalog
=============

Tutor can be extended by making use of "hooks". Hooks are either "actions" or "filters". Here, we list all instances of actions and filters that are used across Tutor. Plugin developers can leverage these hooks to modify the behaviour of Tutor.

The underlying Python hook classes and API are documented :ref:`here <hooks_api>`.

.. autoclass:: tutor.hooks.Actions
    :members:

.. autoclass:: tutor.hooks.Filters
    :members:

.. autoclass:: tutor.hooks.Contexts
    :members:

Open edX hooks
--------------

.. automodule:: tutor.plugins.openedx.hooks
    :members:
feat: refactor hooks API for simplification The hooks API had several issues which are summarized in this comment: https://github.com/openedx/wg-developer-experience/issues/125#issuecomment-1313553526 1. "consts" was a bad name 2. "hooks.filters" and "hooks.Filters" could easily be confused 3. docs made it difficult to understand that plugin developers should use the catalog To address these issues, we: 1. move "consts.py" to "catalog.py" 2. Remove "hooks.actions", "hooks.filters", "hooks.contexts" from the API. 3. re-organize the docs and give better usage examples in the catalog. This change is a partial fix for https://github.com/openedx/wg-developer-experience/issues/125 2023-01-06 18:02:17 +00:00			`.. _hooks_catalog:`

			`=============`
			`Hooks catalog`
			`=============`

			`Tutor can be extended by making use of "hooks". Hooks are either "actions" or "filters". Here, we list all instances of actions and filters that are used across Tutor. Plugin developers can leverage these hooks to modify the behaviour of Tutor.`

			The underlying Python hook classes and API are documented :ref:`here <hooks_api>`.

			`.. autoclass:: tutor.hooks.Actions`
			`:members:`

			`.. autoclass:: tutor.hooks.Filters`
			`:members:`

			`.. autoclass:: tutor.hooks.Contexts`
			`:members:`
feat: auto-mount edx-platform python requirements These changes make to possible to run: tutor mounts add /path/to/my-xblock The xblock directory with then be auto-magically bind-mounted in the "openedx" image at build time, and the lms/cms containers at run time. This makes it effectively possible to work as a developer on edx-platform requirements. We take the opportunity to move some openedx-specific code to a dedicated module. Close https://github.com/openedx/wg-developer-experience/issues/177 2023-09-04 17:08:15 +00:00
			`Open edX hooks`
			`--------------`

			`.. automodule:: tutor.plugins.openedx.hooks`
			`:members:`