summaryrefslogtreecommitdiffstats
path: root/doc/sphinx/Pacemaker_Python_API/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sphinx/Pacemaker_Python_API/index.rst')
-rw-r--r--doc/sphinx/Pacemaker_Python_API/index.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/sphinx/Pacemaker_Python_API/index.rst b/doc/sphinx/Pacemaker_Python_API/index.rst
new file mode 100644
index 0000000..5c7f191
--- /dev/null
+++ b/doc/sphinx/Pacemaker_Python_API/index.rst
@@ -0,0 +1,11 @@
+Contents
+--------
+
+The APIs are documented here in submodules, but each submodule class is
+included at the top level, so code should import directly from the
+``pacemaker`` module. For example, use ``from pacemaker import BuildOptions``,
+not ``from pacemaker.buildoptions import BuildOptions``.
+
+.. toctree::
+
+ api