summaryrefslogtreecommitdiff
path: root/doc/source/api.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/api.rst')
-rw-r--r--doc/source/api.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/source/api.rst b/doc/source/api.rst
new file mode 100644
index 0000000..971225e
--- /dev/null
+++ b/doc/source/api.rst
@@ -0,0 +1,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).