1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
|
********
API docs
********
.. module:: nagiosplugin
The :mod:`nagiosplugin` module consists of several submodules which are
discussed in detail as follows. Refer to the ":ref:`tutorials`" section for an
introduction on how to use them for typical plugins.
.. toctree::
core
intermediate
auxiliary
.. Style
* Talk about class/method/attribute in third person.
* Involved personas: 1. plugin authors, 2. library developers
* Address the documentation reader in second person, i.e. while referring to
another section.
* Use RFC2119 keywords where appropriate.
.. vim: set spell spelllang=en:
|