summaryrefslogtreecommitdiffstats
path: root/doc/sphinx/Pacemaker_Python_API/index.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 06:53:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 06:53:20 +0000
commite5a812082ae033afb1eed82c0f2df3d0f6bdc93f (patch)
treea6716c9275b4b413f6c9194798b34b91affb3cc7 /doc/sphinx/Pacemaker_Python_API/index.rst
parentInitial commit. (diff)
downloadpacemaker-e5a812082ae033afb1eed82c0f2df3d0f6bdc93f.tar.xz
pacemaker-e5a812082ae033afb1eed82c0f2df3d0f6bdc93f.zip
Adding upstream version 2.1.6.upstream/2.1.6
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
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