diff --git a/doc/source/datamodel.rst b/doc/source/developer/datamodel.rst similarity index 100% rename from doc/source/datamodel.rst rename to doc/source/developer/datamodel.rst diff --git a/doc/source/drivers.rst b/doc/source/developer/drivers.rst similarity index 100% rename from doc/source/drivers.rst rename to doc/source/developer/drivers.rst diff --git a/doc/source/developer.rst b/doc/source/developer/index.rst similarity index 96% rename from doc/source/developer.rst rename to doc/source/developer/index.rst index 527ea6e43a..986bbe4298 100644 --- a/doc/source/developer.rst +++ b/doc/source/developer/index.rst @@ -12,4 +12,5 @@ Zuul, though advanced users may find it interesting. datamodel drivers + triggers testing diff --git a/doc/source/testing.rst b/doc/source/developer/testing.rst similarity index 100% rename from doc/source/testing.rst rename to doc/source/developer/testing.rst diff --git a/doc/source/developer/triggers.rst b/doc/source/developer/triggers.rst new file mode 100644 index 0000000000..56f4a037a1 --- /dev/null +++ b/doc/source/developer/triggers.rst @@ -0,0 +1,19 @@ +Triggers +======== + +Triggers must inherit from :py:class:`~zuul.trigger.BaseTrigger` and, at a minimum, +implement the :py:meth:`~zuul.trigger.BaseTrigger.getEventFilters` method. + +.. autoclass:: zuul.trigger.BaseTrigger + :members: + +Current list of triggers are: + +.. autoclass:: zuul.driver.gerrit.gerrittrigger.GerritTrigger + :members: + +.. autoclass:: zuul.driver.timer.timertrigger.TimerTrigger + :members: + +.. autoclass:: zuul.driver.zuul.zuultrigger.ZuulTrigger + :members: diff --git a/doc/source/index.rst b/doc/source/index.rst index 3f903db468..fb30b92be3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -24,7 +24,7 @@ Contents: executors statsd client - developer + developer/index Indices and tables ==================