diff --git a/docs/development/signals.md b/docs/development/signals.md new file mode 100644 index 000000000..8a5d8e43f --- /dev/null +++ b/docs/development/signals.md @@ -0,0 +1,11 @@ +# Signals + +In addition to [Django's built-in signals](https://docs.djangoproject.com/en/stable/topics/signals/), NetBox defines some of its own, listed below. + +## post_clean + +This signal is sent by models which inherit from `CustomValidationMixin` at the end of their `clean()` method. + +### Receivers + +* `extras.signals.run_custom_validators()` diff --git a/mkdocs.yml b/mkdocs.yml index f1ea5d8a7..e1afcb1b7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -90,6 +90,7 @@ nav: - Style Guide: 'development/style-guide.md' - Models: 'development/models.md' - Extending Models: 'development/extending-models.md' + - Signals: 'development/signals.md' - Application Registry: 'development/application-registry.md' - User Preferences: 'development/user-preferences.md' - Release Checklist: 'development/release-checklist.md'