diff --git a/doc/requirements.txt b/doc/requirements.txt index 9da8faa4..01335a15 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,4 +2,5 @@ pyside2 numpy pyopengl sphinx==3.5.4 -pydata_sphinx_theme==0.6.3 \ No newline at end of file +pydata_sphinx_theme==0.6.3 +sphinx-panels \ No newline at end of file diff --git a/doc/source/3dgraphics/glaxisitem.rst b/doc/source/api_reference/3dgraphics/glaxisitem.rst similarity index 100% rename from doc/source/3dgraphics/glaxisitem.rst rename to doc/source/api_reference/3dgraphics/glaxisitem.rst diff --git a/doc/source/3dgraphics/glgraphicsitem.rst b/doc/source/api_reference/3dgraphics/glgraphicsitem.rst similarity index 100% rename from doc/source/3dgraphics/glgraphicsitem.rst rename to doc/source/api_reference/3dgraphics/glgraphicsitem.rst diff --git a/doc/source/3dgraphics/glgriditem.rst b/doc/source/api_reference/3dgraphics/glgriditem.rst similarity index 100% rename from doc/source/3dgraphics/glgriditem.rst rename to doc/source/api_reference/3dgraphics/glgriditem.rst diff --git a/doc/source/3dgraphics/glimageitem.rst b/doc/source/api_reference/3dgraphics/glimageitem.rst similarity index 100% rename from doc/source/3dgraphics/glimageitem.rst rename to doc/source/api_reference/3dgraphics/glimageitem.rst diff --git a/doc/source/3dgraphics/gllineplotitem.rst b/doc/source/api_reference/3dgraphics/gllineplotitem.rst similarity index 100% rename from doc/source/3dgraphics/gllineplotitem.rst rename to doc/source/api_reference/3dgraphics/gllineplotitem.rst diff --git a/doc/source/3dgraphics/glmeshitem.rst b/doc/source/api_reference/3dgraphics/glmeshitem.rst similarity index 100% rename from doc/source/3dgraphics/glmeshitem.rst rename to doc/source/api_reference/3dgraphics/glmeshitem.rst diff --git a/doc/source/3dgraphics/glscatterplotitem.rst b/doc/source/api_reference/3dgraphics/glscatterplotitem.rst similarity index 100% rename from doc/source/3dgraphics/glscatterplotitem.rst rename to doc/source/api_reference/3dgraphics/glscatterplotitem.rst diff --git a/doc/source/3dgraphics/glsurfaceplotitem.rst b/doc/source/api_reference/3dgraphics/glsurfaceplotitem.rst similarity index 100% rename from doc/source/3dgraphics/glsurfaceplotitem.rst rename to doc/source/api_reference/3dgraphics/glsurfaceplotitem.rst diff --git a/doc/source/3dgraphics/glviewwidget.rst b/doc/source/api_reference/3dgraphics/glviewwidget.rst similarity index 100% rename from doc/source/3dgraphics/glviewwidget.rst rename to doc/source/api_reference/3dgraphics/glviewwidget.rst diff --git a/doc/source/3dgraphics/glvolumeitem.rst b/doc/source/api_reference/3dgraphics/glvolumeitem.rst similarity index 100% rename from doc/source/3dgraphics/glvolumeitem.rst rename to doc/source/api_reference/3dgraphics/glvolumeitem.rst diff --git a/doc/source/3dgraphics/index.rst b/doc/source/api_reference/3dgraphics/index.rst similarity index 100% rename from doc/source/3dgraphics/index.rst rename to doc/source/api_reference/3dgraphics/index.rst diff --git a/doc/source/3dgraphics/meshdata.rst b/doc/source/api_reference/3dgraphics/meshdata.rst similarity index 100% rename from doc/source/3dgraphics/meshdata.rst rename to doc/source/api_reference/3dgraphics/meshdata.rst diff --git a/doc/source/flowchart/flowchart.rst b/doc/source/api_reference/flowchart/flowchart.rst similarity index 100% rename from doc/source/flowchart/flowchart.rst rename to doc/source/api_reference/flowchart/flowchart.rst diff --git a/doc/source/flowchart/index.rst b/doc/source/api_reference/flowchart/index.rst similarity index 100% rename from doc/source/flowchart/index.rst rename to doc/source/api_reference/flowchart/index.rst diff --git a/doc/source/flowchart/node.rst b/doc/source/api_reference/flowchart/node.rst similarity index 100% rename from doc/source/flowchart/node.rst rename to doc/source/api_reference/flowchart/node.rst diff --git a/doc/source/flowchart/terminal.rst b/doc/source/api_reference/flowchart/terminal.rst similarity index 100% rename from doc/source/flowchart/terminal.rst rename to doc/source/api_reference/flowchart/terminal.rst diff --git a/doc/source/functions.rst b/doc/source/api_reference/functions.rst similarity index 100% rename from doc/source/functions.rst rename to doc/source/api_reference/functions.rst diff --git a/doc/source/graphicsItems/arrowitem.rst b/doc/source/api_reference/graphicsItems/arrowitem.rst similarity index 100% rename from doc/source/graphicsItems/arrowitem.rst rename to doc/source/api_reference/graphicsItems/arrowitem.rst diff --git a/doc/source/graphicsItems/axisitem.rst b/doc/source/api_reference/graphicsItems/axisitem.rst similarity index 100% rename from doc/source/graphicsItems/axisitem.rst rename to doc/source/api_reference/graphicsItems/axisitem.rst diff --git a/doc/source/graphicsItems/bargraphitem.rst b/doc/source/api_reference/graphicsItems/bargraphitem.rst similarity index 100% rename from doc/source/graphicsItems/bargraphitem.rst rename to doc/source/api_reference/graphicsItems/bargraphitem.rst diff --git a/doc/source/graphicsItems/buttonitem.rst b/doc/source/api_reference/graphicsItems/buttonitem.rst similarity index 100% rename from doc/source/graphicsItems/buttonitem.rst rename to doc/source/api_reference/graphicsItems/buttonitem.rst diff --git a/doc/source/graphicsItems/curvearrow.rst b/doc/source/api_reference/graphicsItems/curvearrow.rst similarity index 100% rename from doc/source/graphicsItems/curvearrow.rst rename to doc/source/api_reference/graphicsItems/curvearrow.rst diff --git a/doc/source/graphicsItems/curvepoint.rst b/doc/source/api_reference/graphicsItems/curvepoint.rst similarity index 100% rename from doc/source/graphicsItems/curvepoint.rst rename to doc/source/api_reference/graphicsItems/curvepoint.rst diff --git a/doc/source/graphicsItems/dateaxisitem.rst b/doc/source/api_reference/graphicsItems/dateaxisitem.rst similarity index 100% rename from doc/source/graphicsItems/dateaxisitem.rst rename to doc/source/api_reference/graphicsItems/dateaxisitem.rst diff --git a/doc/source/graphicsItems/errorbaritem.rst b/doc/source/api_reference/graphicsItems/errorbaritem.rst similarity index 100% rename from doc/source/graphicsItems/errorbaritem.rst rename to doc/source/api_reference/graphicsItems/errorbaritem.rst diff --git a/doc/source/graphicsItems/fillbetweenitem.rst b/doc/source/api_reference/graphicsItems/fillbetweenitem.rst similarity index 100% rename from doc/source/graphicsItems/fillbetweenitem.rst rename to doc/source/api_reference/graphicsItems/fillbetweenitem.rst diff --git a/doc/source/graphicsItems/gradienteditoritem.rst b/doc/source/api_reference/graphicsItems/gradienteditoritem.rst similarity index 100% rename from doc/source/graphicsItems/gradienteditoritem.rst rename to doc/source/api_reference/graphicsItems/gradienteditoritem.rst diff --git a/doc/source/graphicsItems/gradientlegend.rst b/doc/source/api_reference/graphicsItems/gradientlegend.rst similarity index 100% rename from doc/source/graphicsItems/gradientlegend.rst rename to doc/source/api_reference/graphicsItems/gradientlegend.rst diff --git a/doc/source/graphicsItems/graphicsitem.rst b/doc/source/api_reference/graphicsItems/graphicsitem.rst similarity index 100% rename from doc/source/graphicsItems/graphicsitem.rst rename to doc/source/api_reference/graphicsItems/graphicsitem.rst diff --git a/doc/source/graphicsItems/graphicslayout.rst b/doc/source/api_reference/graphicsItems/graphicslayout.rst similarity index 100% rename from doc/source/graphicsItems/graphicslayout.rst rename to doc/source/api_reference/graphicsItems/graphicslayout.rst diff --git a/doc/source/graphicsItems/graphicsobject.rst b/doc/source/api_reference/graphicsItems/graphicsobject.rst similarity index 100% rename from doc/source/graphicsItems/graphicsobject.rst rename to doc/source/api_reference/graphicsItems/graphicsobject.rst diff --git a/doc/source/graphicsItems/graphicswidget.rst b/doc/source/api_reference/graphicsItems/graphicswidget.rst similarity index 100% rename from doc/source/graphicsItems/graphicswidget.rst rename to doc/source/api_reference/graphicsItems/graphicswidget.rst diff --git a/doc/source/graphicsItems/graphicswidgetanchor.rst b/doc/source/api_reference/graphicsItems/graphicswidgetanchor.rst similarity index 100% rename from doc/source/graphicsItems/graphicswidgetanchor.rst rename to doc/source/api_reference/graphicsItems/graphicswidgetanchor.rst diff --git a/doc/source/graphicsItems/graphitem.rst b/doc/source/api_reference/graphicsItems/graphitem.rst similarity index 100% rename from doc/source/graphicsItems/graphitem.rst rename to doc/source/api_reference/graphicsItems/graphitem.rst diff --git a/doc/source/graphicsItems/griditem.rst b/doc/source/api_reference/graphicsItems/griditem.rst similarity index 100% rename from doc/source/graphicsItems/griditem.rst rename to doc/source/api_reference/graphicsItems/griditem.rst diff --git a/doc/source/graphicsItems/histogramlutitem.rst b/doc/source/api_reference/graphicsItems/histogramlutitem.rst similarity index 100% rename from doc/source/graphicsItems/histogramlutitem.rst rename to doc/source/api_reference/graphicsItems/histogramlutitem.rst diff --git a/doc/source/graphicsItems/imageitem.rst b/doc/source/api_reference/graphicsItems/imageitem.rst similarity index 100% rename from doc/source/graphicsItems/imageitem.rst rename to doc/source/api_reference/graphicsItems/imageitem.rst diff --git a/doc/source/graphicsItems/index.rst b/doc/source/api_reference/graphicsItems/index.rst similarity index 100% rename from doc/source/graphicsItems/index.rst rename to doc/source/api_reference/graphicsItems/index.rst diff --git a/doc/source/graphicsItems/infiniteline.rst b/doc/source/api_reference/graphicsItems/infiniteline.rst similarity index 100% rename from doc/source/graphicsItems/infiniteline.rst rename to doc/source/api_reference/graphicsItems/infiniteline.rst diff --git a/doc/source/graphicsItems/isocurveitem.rst b/doc/source/api_reference/graphicsItems/isocurveitem.rst similarity index 100% rename from doc/source/graphicsItems/isocurveitem.rst rename to doc/source/api_reference/graphicsItems/isocurveitem.rst diff --git a/doc/source/graphicsItems/labelitem.rst b/doc/source/api_reference/graphicsItems/labelitem.rst similarity index 100% rename from doc/source/graphicsItems/labelitem.rst rename to doc/source/api_reference/graphicsItems/labelitem.rst diff --git a/doc/source/graphicsItems/legenditem.rst b/doc/source/api_reference/graphicsItems/legenditem.rst similarity index 100% rename from doc/source/graphicsItems/legenditem.rst rename to doc/source/api_reference/graphicsItems/legenditem.rst diff --git a/doc/source/graphicsItems/linearregionitem.rst b/doc/source/api_reference/graphicsItems/linearregionitem.rst similarity index 100% rename from doc/source/graphicsItems/linearregionitem.rst rename to doc/source/api_reference/graphicsItems/linearregionitem.rst diff --git a/doc/source/graphicsItems/make b/doc/source/api_reference/graphicsItems/make similarity index 100% rename from doc/source/graphicsItems/make rename to doc/source/api_reference/graphicsItems/make diff --git a/doc/source/graphicsItems/multiplotitem.rst b/doc/source/api_reference/graphicsItems/multiplotitem.rst similarity index 100% rename from doc/source/graphicsItems/multiplotitem.rst rename to doc/source/api_reference/graphicsItems/multiplotitem.rst diff --git a/doc/source/graphicsItems/pcolormeshitem.rst b/doc/source/api_reference/graphicsItems/pcolormeshitem.rst similarity index 100% rename from doc/source/graphicsItems/pcolormeshitem.rst rename to doc/source/api_reference/graphicsItems/pcolormeshitem.rst diff --git a/doc/source/graphicsItems/plotcurveitem.rst b/doc/source/api_reference/graphicsItems/plotcurveitem.rst similarity index 100% rename from doc/source/graphicsItems/plotcurveitem.rst rename to doc/source/api_reference/graphicsItems/plotcurveitem.rst diff --git a/doc/source/graphicsItems/plotdataitem.rst b/doc/source/api_reference/graphicsItems/plotdataitem.rst similarity index 100% rename from doc/source/graphicsItems/plotdataitem.rst rename to doc/source/api_reference/graphicsItems/plotdataitem.rst diff --git a/doc/source/graphicsItems/plotitem.rst b/doc/source/api_reference/graphicsItems/plotitem.rst similarity index 100% rename from doc/source/graphicsItems/plotitem.rst rename to doc/source/api_reference/graphicsItems/plotitem.rst diff --git a/doc/source/graphicsItems/roi.rst b/doc/source/api_reference/graphicsItems/roi.rst similarity index 100% rename from doc/source/graphicsItems/roi.rst rename to doc/source/api_reference/graphicsItems/roi.rst diff --git a/doc/source/graphicsItems/scalebar.rst b/doc/source/api_reference/graphicsItems/scalebar.rst similarity index 100% rename from doc/source/graphicsItems/scalebar.rst rename to doc/source/api_reference/graphicsItems/scalebar.rst diff --git a/doc/source/graphicsItems/scatterplotitem.rst b/doc/source/api_reference/graphicsItems/scatterplotitem.rst similarity index 100% rename from doc/source/graphicsItems/scatterplotitem.rst rename to doc/source/api_reference/graphicsItems/scatterplotitem.rst diff --git a/doc/source/graphicsItems/targetitem.rst b/doc/source/api_reference/graphicsItems/targetitem.rst similarity index 100% rename from doc/source/graphicsItems/targetitem.rst rename to doc/source/api_reference/graphicsItems/targetitem.rst diff --git a/doc/source/graphicsItems/textitem.rst b/doc/source/api_reference/graphicsItems/textitem.rst similarity index 100% rename from doc/source/graphicsItems/textitem.rst rename to doc/source/api_reference/graphicsItems/textitem.rst diff --git a/doc/source/graphicsItems/uigraphicsitem.rst b/doc/source/api_reference/graphicsItems/uigraphicsitem.rst similarity index 100% rename from doc/source/graphicsItems/uigraphicsitem.rst rename to doc/source/api_reference/graphicsItems/uigraphicsitem.rst diff --git a/doc/source/graphicsItems/viewbox.rst b/doc/source/api_reference/graphicsItems/viewbox.rst similarity index 100% rename from doc/source/graphicsItems/viewbox.rst rename to doc/source/api_reference/graphicsItems/viewbox.rst diff --git a/doc/source/graphicsItems/vtickgroup.rst b/doc/source/api_reference/graphicsItems/vtickgroup.rst similarity index 100% rename from doc/source/graphicsItems/vtickgroup.rst rename to doc/source/api_reference/graphicsItems/vtickgroup.rst diff --git a/doc/source/graphicsscene/graphicsscene.rst b/doc/source/api_reference/graphicsscene/graphicsscene.rst similarity index 100% rename from doc/source/graphicsscene/graphicsscene.rst rename to doc/source/api_reference/graphicsscene/graphicsscene.rst diff --git a/doc/source/graphicsscene/hoverevent.rst b/doc/source/api_reference/graphicsscene/hoverevent.rst similarity index 100% rename from doc/source/graphicsscene/hoverevent.rst rename to doc/source/api_reference/graphicsscene/hoverevent.rst diff --git a/doc/source/graphicsscene/index.rst b/doc/source/api_reference/graphicsscene/index.rst similarity index 100% rename from doc/source/graphicsscene/index.rst rename to doc/source/api_reference/graphicsscene/index.rst diff --git a/doc/source/graphicsscene/mouseclickevent.rst b/doc/source/api_reference/graphicsscene/mouseclickevent.rst similarity index 100% rename from doc/source/graphicsscene/mouseclickevent.rst rename to doc/source/api_reference/graphicsscene/mouseclickevent.rst diff --git a/doc/source/graphicsscene/mousedragevent.rst b/doc/source/api_reference/graphicsscene/mousedragevent.rst similarity index 100% rename from doc/source/graphicsscene/mousedragevent.rst rename to doc/source/api_reference/graphicsscene/mousedragevent.rst diff --git a/doc/source/graphicswindow.rst b/doc/source/api_reference/graphicswindow.rst similarity index 100% rename from doc/source/graphicswindow.rst rename to doc/source/api_reference/graphicswindow.rst diff --git a/doc/source/apireference.rst b/doc/source/api_reference/index.rst similarity index 75% rename from doc/source/apireference.rst rename to doc/source/api_reference/index.rst index 2392a65e..c0f90b64 100644 --- a/doc/source/apireference.rst +++ b/doc/source/api_reference/index.rst @@ -6,14 +6,11 @@ Contents: .. toctree:: :maxdepth: 2 - config_options functions graphicsItems/index widgets/index 3dgraphics/index - colormap - parametertree/apiref - dockarea - graphicsscene/index + parametertree/index flowchart/index graphicswindow + graphicsscene/index diff --git a/doc/source/parametertree/apiref.rst b/doc/source/api_reference/parametertree/apiref.rst similarity index 100% rename from doc/source/parametertree/apiref.rst rename to doc/source/api_reference/parametertree/apiref.rst diff --git a/doc/source/parametertree/index.rst b/doc/source/api_reference/parametertree/index.rst similarity index 100% rename from doc/source/parametertree/index.rst rename to doc/source/api_reference/parametertree/index.rst diff --git a/doc/source/parametertree/parameter.rst b/doc/source/api_reference/parametertree/parameter.rst similarity index 100% rename from doc/source/parametertree/parameter.rst rename to doc/source/api_reference/parametertree/parameter.rst diff --git a/doc/source/parametertree/parameteritem.rst b/doc/source/api_reference/parametertree/parameteritem.rst similarity index 100% rename from doc/source/parametertree/parameteritem.rst rename to doc/source/api_reference/parametertree/parameteritem.rst diff --git a/doc/source/parametertree/parametertree.rst b/doc/source/api_reference/parametertree/parametertree.rst similarity index 100% rename from doc/source/parametertree/parametertree.rst rename to doc/source/api_reference/parametertree/parametertree.rst diff --git a/doc/source/parametertree/parametertypes.rst b/doc/source/api_reference/parametertree/parametertypes.rst similarity index 100% rename from doc/source/parametertree/parametertypes.rst rename to doc/source/api_reference/parametertree/parametertypes.rst diff --git a/doc/source/widgets/busycursor.rst b/doc/source/api_reference/widgets/busycursor.rst similarity index 100% rename from doc/source/widgets/busycursor.rst rename to doc/source/api_reference/widgets/busycursor.rst diff --git a/doc/source/widgets/checktable.rst b/doc/source/api_reference/widgets/checktable.rst similarity index 100% rename from doc/source/widgets/checktable.rst rename to doc/source/api_reference/widgets/checktable.rst diff --git a/doc/source/widgets/colorbutton.rst b/doc/source/api_reference/widgets/colorbutton.rst similarity index 100% rename from doc/source/widgets/colorbutton.rst rename to doc/source/api_reference/widgets/colorbutton.rst diff --git a/doc/source/widgets/colormapwidget.rst b/doc/source/api_reference/widgets/colormapwidget.rst similarity index 100% rename from doc/source/widgets/colormapwidget.rst rename to doc/source/api_reference/widgets/colormapwidget.rst diff --git a/doc/source/widgets/combobox.rst b/doc/source/api_reference/widgets/combobox.rst similarity index 100% rename from doc/source/widgets/combobox.rst rename to doc/source/api_reference/widgets/combobox.rst diff --git a/doc/source/widgets/consolewidget.rst b/doc/source/api_reference/widgets/consolewidget.rst similarity index 100% rename from doc/source/widgets/consolewidget.rst rename to doc/source/api_reference/widgets/consolewidget.rst diff --git a/doc/source/widgets/datatreewidget.rst b/doc/source/api_reference/widgets/datatreewidget.rst similarity index 100% rename from doc/source/widgets/datatreewidget.rst rename to doc/source/api_reference/widgets/datatreewidget.rst diff --git a/doc/source/widgets/feedbackbutton.rst b/doc/source/api_reference/widgets/feedbackbutton.rst similarity index 100% rename from doc/source/widgets/feedbackbutton.rst rename to doc/source/api_reference/widgets/feedbackbutton.rst diff --git a/doc/source/widgets/filedialog.rst b/doc/source/api_reference/widgets/filedialog.rst similarity index 100% rename from doc/source/widgets/filedialog.rst rename to doc/source/api_reference/widgets/filedialog.rst diff --git a/doc/source/widgets/gradientwidget.rst b/doc/source/api_reference/widgets/gradientwidget.rst similarity index 100% rename from doc/source/widgets/gradientwidget.rst rename to doc/source/api_reference/widgets/gradientwidget.rst diff --git a/doc/source/widgets/graphicslayoutwidget.rst b/doc/source/api_reference/widgets/graphicslayoutwidget.rst similarity index 100% rename from doc/source/widgets/graphicslayoutwidget.rst rename to doc/source/api_reference/widgets/graphicslayoutwidget.rst diff --git a/doc/source/widgets/graphicsview.rst b/doc/source/api_reference/widgets/graphicsview.rst similarity index 100% rename from doc/source/widgets/graphicsview.rst rename to doc/source/api_reference/widgets/graphicsview.rst diff --git a/doc/source/widgets/histogramlutwidget.rst b/doc/source/api_reference/widgets/histogramlutwidget.rst similarity index 100% rename from doc/source/widgets/histogramlutwidget.rst rename to doc/source/api_reference/widgets/histogramlutwidget.rst diff --git a/doc/source/widgets/imageview.rst b/doc/source/api_reference/widgets/imageview.rst similarity index 100% rename from doc/source/widgets/imageview.rst rename to doc/source/api_reference/widgets/imageview.rst diff --git a/doc/source/widgets/index.rst b/doc/source/api_reference/widgets/index.rst similarity index 100% rename from doc/source/widgets/index.rst rename to doc/source/api_reference/widgets/index.rst diff --git a/doc/source/widgets/joystickbutton.rst b/doc/source/api_reference/widgets/joystickbutton.rst similarity index 100% rename from doc/source/widgets/joystickbutton.rst rename to doc/source/api_reference/widgets/joystickbutton.rst diff --git a/doc/source/widgets/layoutwidget.rst b/doc/source/api_reference/widgets/layoutwidget.rst similarity index 100% rename from doc/source/widgets/layoutwidget.rst rename to doc/source/api_reference/widgets/layoutwidget.rst diff --git a/doc/source/widgets/make b/doc/source/api_reference/widgets/make similarity index 100% rename from doc/source/widgets/make rename to doc/source/api_reference/widgets/make diff --git a/doc/source/widgets/matplotlibwidget.rst b/doc/source/api_reference/widgets/matplotlibwidget.rst similarity index 100% rename from doc/source/widgets/matplotlibwidget.rst rename to doc/source/api_reference/widgets/matplotlibwidget.rst diff --git a/doc/source/widgets/multiplotwidget.rst b/doc/source/api_reference/widgets/multiplotwidget.rst similarity index 100% rename from doc/source/widgets/multiplotwidget.rst rename to doc/source/api_reference/widgets/multiplotwidget.rst diff --git a/doc/source/widgets/pathbutton.rst b/doc/source/api_reference/widgets/pathbutton.rst similarity index 100% rename from doc/source/widgets/pathbutton.rst rename to doc/source/api_reference/widgets/pathbutton.rst diff --git a/doc/source/widgets/plotwidget.rst b/doc/source/api_reference/widgets/plotwidget.rst similarity index 100% rename from doc/source/widgets/plotwidget.rst rename to doc/source/api_reference/widgets/plotwidget.rst diff --git a/doc/source/widgets/progressdialog.rst b/doc/source/api_reference/widgets/progressdialog.rst similarity index 100% rename from doc/source/widgets/progressdialog.rst rename to doc/source/api_reference/widgets/progressdialog.rst diff --git a/doc/source/widgets/remotegraphicsview.rst b/doc/source/api_reference/widgets/remotegraphicsview.rst similarity index 100% rename from doc/source/widgets/remotegraphicsview.rst rename to doc/source/api_reference/widgets/remotegraphicsview.rst diff --git a/doc/source/widgets/scatterplotwidget.rst b/doc/source/api_reference/widgets/scatterplotwidget.rst similarity index 100% rename from doc/source/widgets/scatterplotwidget.rst rename to doc/source/api_reference/widgets/scatterplotwidget.rst diff --git a/doc/source/widgets/spinbox.rst b/doc/source/api_reference/widgets/spinbox.rst similarity index 100% rename from doc/source/widgets/spinbox.rst rename to doc/source/api_reference/widgets/spinbox.rst diff --git a/doc/source/widgets/tablewidget.rst b/doc/source/api_reference/widgets/tablewidget.rst similarity index 100% rename from doc/source/widgets/tablewidget.rst rename to doc/source/api_reference/widgets/tablewidget.rst diff --git a/doc/source/widgets/treewidget.rst b/doc/source/api_reference/widgets/treewidget.rst similarity index 100% rename from doc/source/widgets/treewidget.rst rename to doc/source/api_reference/widgets/treewidget.rst diff --git a/doc/source/widgets/valuelabel.rst b/doc/source/api_reference/widgets/valuelabel.rst similarity index 100% rename from doc/source/widgets/valuelabel.rst rename to doc/source/api_reference/widgets/valuelabel.rst diff --git a/doc/source/widgets/verticallabel.rst b/doc/source/api_reference/widgets/verticallabel.rst similarity index 100% rename from doc/source/widgets/verticallabel.rst rename to doc/source/api_reference/widgets/verticallabel.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 41db21c3..e4323796 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -31,7 +31,12 @@ import pyqtgraph # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon'] +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.viewcode', + 'sphinx.ext.napoleon', + 'sphinx_panels' +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/doc/source/development/index.rst b/doc/source/development/index.rst new file mode 100644 index 00000000..e9af8b77 --- /dev/null +++ b/doc/source/development/index.rst @@ -0,0 +1,8 @@ +Developer Guide +=============== + +File to contain contents for development guide + +.. toctree:: + + internals diff --git a/doc/source/internals.rst b/doc/source/development/internals.rst similarity index 100% rename from doc/source/internals.rst rename to doc/source/development/internals.rst diff --git a/doc/source/how_to_use.rst b/doc/source/getting_started/how_to_use.rst similarity index 100% rename from doc/source/how_to_use.rst rename to doc/source/getting_started/how_to_use.rst diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst new file mode 100644 index 00000000..ad733a78 --- /dev/null +++ b/doc/source/getting_started/index.rst @@ -0,0 +1,12 @@ +Getting Started +=============== + +Contents involving getting started + +Contents: + +.. toctree:: + installation + how_to_use + qtcrashcourse + introduction diff --git a/doc/source/installation.rst b/doc/source/getting_started/installation.rst similarity index 100% rename from doc/source/installation.rst rename to doc/source/getting_started/installation.rst diff --git a/doc/source/introduction.rst b/doc/source/getting_started/introduction.rst similarity index 100% rename from doc/source/introduction.rst rename to doc/source/getting_started/introduction.rst diff --git a/doc/source/qtcrashcourse.rst b/doc/source/getting_started/qtcrashcourse.rst similarity index 100% rename from doc/source/qtcrashcourse.rst rename to doc/source/getting_started/qtcrashcourse.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 08c5528e..07a89828 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -8,26 +8,70 @@ Welcome to the documentation for pyqtgraph Contents: -.. toctree:: - :maxdepth: 2 +.. panels:: + :card: + intro-card text-center + :column: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex - introduction - mouse_interaction - how_to_use - installation - qtcrashcourse - plotting - images - 3dgraphics - style - region_of_interest - exporting - prototyping - parametertree/index - flowchart/index - internals - apireference - + --- + + Getting started + ^^^^^^^^^^^^^^^ + + New to *pyqtgraph*? Check out the getting started guides. They contain an + introduction to *pyqtgraph'* main concepts and links to additional tutorials, + as well as information needed to know about the Qt framework. + + +++ + + .. link-button:: getting_started/index + :type: ref + :text: To the getting started guides + :classes: btn-block btn-secondary stretched-link + + --- + + User guide + ^^^^^^^^^^ + + The user guide provides in-depth information on various *pyqtgraph* objects, + and typical use cases. + + +++ + + .. link-button:: user_guide/index + :type: ref + :text: To the user guide + :classes: btn-block btn-secondary stretched-link + + --- + + API reference + ^^^^^^^^^^^^^ + + The reference guide contains a detailed description of + the *pyqtgraph* API. The reference describes how pyqtgraph and Qt objects work and which parameters can + be used. + + +++ + + .. link-button:: api_reference/index + :type: ref + :text: To the reference guide + :classes: btn-block btn-secondary stretched-link + + --- + + Developer guide + ^^^^^^^^^^^^^^^ + + Guide for developing or contributing to *pyqtgraph* + + +++ + + .. link-button:: development/index + :type: ref + :text: To the development guide + :classes: btn-block btn-secondary stretched-link Indices and tables ================== diff --git a/doc/source/3dgraphics.rst b/doc/source/user_guide/3dgraphics.rst similarity index 100% rename from doc/source/3dgraphics.rst rename to doc/source/user_guide/3dgraphics.rst diff --git a/doc/source/colormap.rst b/doc/source/user_guide/colormap.rst similarity index 100% rename from doc/source/colormap.rst rename to doc/source/user_guide/colormap.rst diff --git a/doc/source/config_options.rst b/doc/source/user_guide/config_options.rst similarity index 100% rename from doc/source/config_options.rst rename to doc/source/user_guide/config_options.rst diff --git a/doc/source/dockarea.rst b/doc/source/user_guide/dockarea.rst similarity index 100% rename from doc/source/dockarea.rst rename to doc/source/user_guide/dockarea.rst diff --git a/doc/source/exporting.rst b/doc/source/user_guide/exporting.rst similarity index 100% rename from doc/source/exporting.rst rename to doc/source/user_guide/exporting.rst diff --git a/doc/source/images.rst b/doc/source/user_guide/images.rst similarity index 100% rename from doc/source/images.rst rename to doc/source/user_guide/images.rst diff --git a/doc/source/images/plottingClasses.png b/doc/source/user_guide/images/plottingClasses.png similarity index 100% rename from doc/source/images/plottingClasses.png rename to doc/source/user_guide/images/plottingClasses.png diff --git a/doc/source/images/plottingClasses.svg b/doc/source/user_guide/images/plottingClasses.svg similarity index 100% rename from doc/source/images/plottingClasses.svg rename to doc/source/user_guide/images/plottingClasses.svg diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst new file mode 100644 index 00000000..ededefdf --- /dev/null +++ b/doc/source/user_guide/index.rst @@ -0,0 +1,19 @@ +User Guide +========== + +Contents: + +.. toctree:: + config_options + mouse_interaction + plotting + images + colormap + dockarea + 3dgraphics + style + region_of_interest + exporting + prototyping + +The following is a user guide for using portions of the library diff --git a/doc/source/mouse_interaction.rst b/doc/source/user_guide/mouse_interaction.rst similarity index 100% rename from doc/source/mouse_interaction.rst rename to doc/source/user_guide/mouse_interaction.rst diff --git a/doc/source/plotting.rst b/doc/source/user_guide/plotting.rst similarity index 100% rename from doc/source/plotting.rst rename to doc/source/user_guide/plotting.rst diff --git a/doc/source/prototyping.rst b/doc/source/user_guide/prototyping.rst similarity index 100% rename from doc/source/prototyping.rst rename to doc/source/user_guide/prototyping.rst diff --git a/doc/source/region_of_interest.rst b/doc/source/user_guide/region_of_interest.rst similarity index 100% rename from doc/source/region_of_interest.rst rename to doc/source/user_guide/region_of_interest.rst diff --git a/doc/source/style.rst b/doc/source/user_guide/style.rst similarity index 100% rename from doc/source/style.rst rename to doc/source/user_guide/style.rst