Browse Source

Add trigger developer doc

Move developer docs to their own subdir (to avoid filename conflicts
with current doc set), and add a (very basic) new dev doc for triggers.

Change-Id: I0dce63ab9fa470247c4bbd4aae58dc97cdf8a517
changes/95/453695/1
David Shrewsbury 5 years ago
parent
commit
95ec6202af
  1. 0
      doc/source/developer/datamodel.rst
  2. 0
      doc/source/developer/drivers.rst
  3. 1
      doc/source/developer/index.rst
  4. 0
      doc/source/developer/testing.rst
  5. 19
      doc/source/developer/triggers.rst
  6. 2
      doc/source/index.rst

0
doc/source/datamodel.rst → doc/source/developer/datamodel.rst

0
doc/source/drivers.rst → doc/source/developer/drivers.rst

1
doc/source/developer.rst → doc/source/developer/index.rst

@ -12,4 +12,5 @@ Zuul, though advanced users may find it interesting.
datamodel
drivers
triggers
testing

0
doc/source/testing.rst → doc/source/developer/testing.rst

19
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:

2
doc/source/index.rst

@ -24,7 +24,7 @@ Contents:
executors
statsd
client
developer
developer/index
Indices and tables
==================

Loading…
Cancel
Save