From fa99ca924671d930cb4087fb39f1a57310747e79 Mon Sep 17 00:00:00 2001 From: baldurk Date: Mon, 22 Oct 2018 16:54:01 +0100 Subject: [PATCH] Document python extensions API --- docs/python_api/qrenderdoc/extensions.rst | 36 +++++++++++++++++++++++ docs/python_api/qrenderdoc/index.rst | 4 ++- 2 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 docs/python_api/qrenderdoc/extensions.rst diff --git a/docs/python_api/qrenderdoc/extensions.rst b/docs/python_api/qrenderdoc/extensions.rst new file mode 100644 index 000000000..9b04234dd --- /dev/null +++ b/docs/python_api/qrenderdoc/extensions.rst @@ -0,0 +1,36 @@ +UI Extensions +============= + +.. contents:: + +.. currentmodule:: qrenderdoc + +Extension Manager +----------------- + +.. autoclass:: qrenderdoc.ExtensionManager + :members: + :undoc-members: + +Helpers +------- + +.. autoclass:: qrenderdoc.ExtensionMetadata + :members: + :undoc-members: + +.. autoclass:: qrenderdoc.WindowMenu + :members: + :undoc-members: + :exclude-members: enum_constants__, + +.. autoclass:: qrenderdoc.PanelMenu + :members: + :undoc-members: + :exclude-members: enum_constants__, + +.. autoclass:: qrenderdoc.ContextMenu + :members: + :undoc-members: + :exclude-members: enum_constants__, + diff --git a/docs/python_api/qrenderdoc/index.rst b/docs/python_api/qrenderdoc/index.rst index a165a146b..4e5417125 100644 --- a/docs/python_api/qrenderdoc/index.rst +++ b/docs/python_api/qrenderdoc/index.rst @@ -5,9 +5,11 @@ qrenderdoc API Reference :hidden: main + extensions windows config * :doc:`main` +* :doc:`extensions` * :doc:`windows` -* :doc:`config` \ No newline at end of file +* :doc:`config`