diff --git a/doc/sphinx/Pacemaker_Python_API/api.rst b/doc/sphinx/Pacemaker_Python_API/api.rst index 3a9187cd08..725daaf85c 100644 --- a/doc/sphinx/Pacemaker_Python_API/api.rst +++ b/doc/sphinx/Pacemaker_Python_API/api.rst @@ -1,9 +1,8 @@ -API -=== +API Reference +============= -.. autosummary:: - :toctree: generated +.. toctree:: pacemaker pacemaker.buildoptions pacemaker.exitstatus diff --git a/doc/sphinx/Pacemaker_Python_API/index.rst b/doc/sphinx/Pacemaker_Python_API/index.rst index a4a293e0ee..d7802f2fdc 100644 --- a/doc/sphinx/Pacemaker_Python_API/index.rst +++ b/doc/sphinx/Pacemaker_Python_API/index.rst @@ -1,20 +1,21 @@ Pacemaker Python Module ------------------------ +======================= -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``. +This is the Python interface to the `Pacemaker `_ +project. At the moment, it doesn't do very much but we are planning to expand +its capabilities over time. .. toctree:: :maxdepth: 2 api -Index ------ +.. only:: builder_epub or builder_html or builder_pdf -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + Index + ===== + + * :ref:`genindex` + * :ref:`modindex` + * :ref:`search` diff --git a/doc/sphinx/Pacemaker_Python_API/pacemaker.buildoptions.rst b/doc/sphinx/Pacemaker_Python_API/pacemaker.buildoptions.rst new file mode 100644 index 0000000000..3a6f3cb174 --- /dev/null +++ b/doc/sphinx/Pacemaker_Python_API/pacemaker.buildoptions.rst @@ -0,0 +1,5 @@ +Build Options +============= + +.. autoclass:: pacemaker.BuildOptions + :members: diff --git a/doc/sphinx/Pacemaker_Python_API/pacemaker.exitstatus.rst b/doc/sphinx/Pacemaker_Python_API/pacemaker.exitstatus.rst new file mode 100644 index 0000000000..de41dc271d --- /dev/null +++ b/doc/sphinx/Pacemaker_Python_API/pacemaker.exitstatus.rst @@ -0,0 +1,6 @@ +Exit Status +=========== + +.. autoclass:: pacemaker.ExitStatus + :members: + :undoc-members: diff --git a/doc/sphinx/Pacemaker_Python_API/pacemaker.rst b/doc/sphinx/Pacemaker_Python_API/pacemaker.rst new file mode 100644 index 0000000000..ba8493cc5d --- /dev/null +++ b/doc/sphinx/Pacemaker_Python_API/pacemaker.rst @@ -0,0 +1,9 @@ +Pacemaker +========= + +The pacemaker module re-exports its submodules, so code should import directly from +the ``pacemaker`` module: + +.. code-block:: python + + >>> from pacemaker import BuildOptions