File: index.rst

package info (click to toggle)
nagiosplugin 1.3.2-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 948 kB
  • sloc: python: 1,857; makefile: 139; sh: 8
file content (25 lines) | stat: -rw-r--r-- 622 bytes parent folder | download | duplicates (2)
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: