summaryrefslogtreecommitdiff
path: root/doc/source/api.rst
blob: 971225e7ae643bcb78ad3ccd0f8927a1fa8ab23d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
=====
 API
=====

.. Use autodoc directives to describe the *public* modules and classes
   in the library.

   If the modules are completely unrelated, create an api subdirectory
   and use a separate file for each (see oslo.utils).

   If there is only one submodule, a single api.rst file like this
   sufficient (see oslo.i18n).