From 447001876e6461dc14d2158d98883164b6122f8d Mon Sep 17 00:00:00 2001 From: Billy Su Date: Mon, 5 Feb 2018 22:47:45 +0800 Subject: [PATCH] API Reference add Graphics Windows --- doc/source/apireference.rst | 1 + .../graphicsWindows/graphicsWindows.rst | 22 +++++++++++++++++++ doc/source/graphicsWindows/index.rst | 11 ++++++++++ 3 files changed, 34 insertions(+) create mode 100644 doc/source/graphicsWindows/graphicsWindows.rst create mode 100644 doc/source/graphicsWindows/index.rst diff --git a/doc/source/apireference.rst b/doc/source/apireference.rst index c4dc64aa..bca04bb8 100644 --- a/doc/source/apireference.rst +++ b/doc/source/apireference.rst @@ -9,6 +9,7 @@ Contents: config_options functions graphicsItems/index + graphicsWindows/index widgets/index 3dgraphics/index colormap diff --git a/doc/source/graphicsWindows/graphicsWindows.rst b/doc/source/graphicsWindows/graphicsWindows.rst new file mode 100644 index 00000000..4ce96b36 --- /dev/null +++ b/doc/source/graphicsWindows/graphicsWindows.rst @@ -0,0 +1,22 @@ +Graphics Windows +================ + +.. autoclass:: pyqtgraph.GraphicsWindow + :members: + + .. automethod:: pyqtgraph.GraphicsWindow.__init__ + +.. autoclass:: pyqtgraph.TabWindow + :members: + + .. automethod:: pyqtgraph.TabWindow.__init__ + +.. autoclass:: pyqtgraph.PlotWindow + :members: + + .. automethod:: pyqtgraph.PlotWindow.__init__ + +.. autoclass:: pyqtgraph.ImageWindow + :members: + + .. automethod:: pyqtgraph.ImageWindow.__init__ \ No newline at end of file diff --git a/doc/source/graphicsWindows/index.rst b/doc/source/graphicsWindows/index.rst new file mode 100644 index 00000000..5187cfdc --- /dev/null +++ b/doc/source/graphicsWindows/index.rst @@ -0,0 +1,11 @@ +Graphics Windows +================ + +Convenience classes which create a new window with PlotWidget or ImageView. + +Contents: + +.. toctree:: + :maxdepth: 2 + + graphicsWindows \ No newline at end of file