DOC #215 existing API documentation

BCDA-APS · Mar 23, 2024 · 40050ab · 40050ab
1 parent 35ecc0b
commit 40050ab
Show file tree

Hide file tree

Showing 25 changed files with 173 additions and 38 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -0,0 +1,10 @@
+====================================
+Source Code Documentation
+====================================
+
+.. toctree::
+ :glob:
+ :caption: Contents:
+
+ api/*
+ testing
diff --git a/docs/source/api/aboutdialog.rst b/docs/source/api/aboutdialog.rst
@@ -0,0 +1,7 @@
+====================================
+About Dialog
+====================================
+
+.. automodule:: gemviz.aboutdialog
+ :members:
+ :private-members:
diff --git a/docs/source/api/app.rst b/docs/source/api/app.rst
@@ -0,0 +1,7 @@
+====================================
+Application starting point.
+====================================
+
+.. automodule:: gemviz.app
+ :members:
+ :private-members:
diff --git a/docs/source/api/bluesky_runs_catalog.rst b/docs/source/api/bluesky_runs_catalog.rst
@@ -0,0 +1,7 @@
+====================================
+BRC_MVC
+====================================
+
+.. automodule:: gemviz.bluesky_runs_catalog
+ :members:
+ :private-members:
diff --git a/docs/source/api/bluesky_runs_catalog_run_viz.rst b/docs/source/api/bluesky_runs_catalog_run_viz.rst
@@ -0,0 +1,7 @@
+====================================
+bluesky_runs_catalog_run_viz
+====================================
+
+.. automodule:: gemviz.bluesky_runs_catalog_run_viz
+ :members:
+ :private-members:
diff --git a/docs/source/api/bluesky_runs_catalog_search.rst b/docs/source/api/bluesky_runs_catalog_search.rst
@@ -0,0 +1,7 @@
+====================================
+bluesky_runs_catalog_search
+====================================
+
+.. automodule:: gemviz.bluesky_runs_catalog_search
+ :members:
+ :private-members:
diff --git a/docs/source/api/bluesky_runs_catalog_table_model.rst b/docs/source/api/bluesky_runs_catalog_table_model.rst
@@ -0,0 +1,7 @@
+====================================
+bluesky_runs_catalog_table_model
+====================================
+
+.. automodule:: gemviz.bluesky_runs_catalog_table_model
+ :members:
+ :private-members:
diff --git a/docs/source/api/bluesky_runs_catalog_table_view.rst b/docs/source/api/bluesky_runs_catalog_table_view.rst
@@ -0,0 +1,7 @@
+====================================
+bluesky_runs_catalog_table_view
+====================================
+
+.. automodule:: gemviz.bluesky_runs_catalog_table_view
+ :members:
+ :private-members:
diff --git a/docs/source/api/chartview.rst b/docs/source/api/chartview.rst
@@ -0,0 +1,7 @@
+====================================
+Chartview
+====================================
+
+.. automodule:: gemviz.chartview
+ :members:
+ :private-members:
diff --git a/docs/source/api/date_time_range_slider.rst b/docs/source/api/date_time_range_slider.rst
@@ -0,0 +1,7 @@
+====================================
+DateTimeRangeSlider
+====================================
+
+.. automodule:: gemviz.date_time_range_slider
+ :members:
+ :private-members:
diff --git a/docs/source/api/licensedialog.rst b/docs/source/api/licensedialog.rst
@@ -0,0 +1,7 @@
+====================================
+License Dialog
+====================================
+
+.. automodule:: gemviz.licensedialog
+ :members:
+ :private-members:
diff --git a/docs/source/api/mainwindow.rst b/docs/source/api/mainwindow.rst
@@ -0,0 +1,7 @@
+====================================
+Main Window of GUI
+====================================
+
+.. automodule:: gemviz.mainwindow
+ :members:
+ :private-members:
diff --git a/docs/source/api/range_slider.rst b/docs/source/api/range_slider.rst
@@ -0,0 +1,7 @@
+====================================
+Range Slider
+====================================
+
+.. automodule:: gemviz.range_slider
+ :members:
+ :private-members:
diff --git a/docs/source/api/select_fields_tablemodel.rst b/docs/source/api/select_fields_tablemodel.rst
@@ -0,0 +1,7 @@
+====================================
+select_fields_tablemodel
+====================================
+
+.. automodule:: gemviz.select_fields_tablemodel
+ :members:
+ :private-members:
diff --git a/docs/source/api/select_fields_tableview.rst b/docs/source/api/select_fields_tableview.rst
@@ -0,0 +1,7 @@
+====================================
+select_fields_tableview
+====================================
+
+.. automodule:: gemviz.select_fields_tableview
+ :members:
+ :private-members:
diff --git a/docs/source/api/select_stream_fields.rst b/docs/source/api/select_stream_fields.rst
@@ -0,0 +1,7 @@
+====================================
+select_stream_fields
+====================================
+
+.. automodule:: gemviz.select_stream_fields
+ :members:
+ :private-members:
diff --git a/docs/source/api/tapi.rst b/docs/source/api/tapi.rst
@@ -0,0 +1,7 @@
+============================================
+TAPI: Tiled Application Programmer Interface
+============================================
+
+.. automodule:: gemviz.tapi
+ :members:
+ :private-members:
diff --git a/docs/source/api/tiledserverdialog.rst b/docs/source/api/tiledserverdialog.rst
@@ -0,0 +1,7 @@
+====================================
+tiledserverdialog
+====================================
+
+.. automodule:: gemviz.tiledserverdialog
+ :members:
+ :private-members:
diff --git a/docs/source/api/user_settings.rst b/docs/source/api/user_settings.rst
@@ -0,0 +1,7 @@
+====================================
+User Settings
+====================================
+
+.. automodule:: gemviz.user_settings
+ :members:
+ :private-members:
diff --git a/docs/source/api/utils.rst b/docs/source/api/utils.rst
@@ -0,0 +1,7 @@
+====================================
+Utility Functions
+====================================
+
+.. automodule:: gemviz.utils
+ :members:
+ :private-members:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,17 +1,14 @@
-.. gemviz documentation master file, created by
- sphinx-quickstart on Wed Sep 27 11:01:03 2023.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
-==================================
-Welcome to gemviz's documentation!
-==================================
+=========================
+gemviz: View Bluesky Data
+=========================
 
 .. toctree::
  :maxdepth: 2
+ :glob:
  :caption: Contents:
 
- testing
+ user_guide
+ api
 
 References
 ==========

diff --git a/docs/source/user_guide.rst b/docs/source/user_guide.rst
@@ -0,0 +1,8 @@
+====================================
+User Guide
+====================================
+
+Command-line
+------------
+
+todo
diff --git a/gemviz/chartview.py b/gemviz/chartview.py
@@ -1,19 +1,22 @@
 """
-Charting widget
+Qt widget that shows the plot.
 
 .. autosummary::
 
  ~auto_color
  ~auto_symbol
  ~ChartView
+ ~PLOT_COLORS
+ ~PLOT_SYMBOLS
+ ~TIMESTAMP_LIMIT
 
-.. seealso:: https://matplotlib.org/stable/users/index.html
+:see: https://matplotlib.org/stable/users/index.html
 
-Plot Symbols
+.. note:: To see the full list of plot symbols from
+ MatPlotLib (https://matplotlib.org/stable/gallery/lines_bars_and_markers/marker_reference.html)::
 
-# https://matplotlib.org/stable/gallery/lines_bars_and_markers/marker_reference.html
-# from matplotlib.lines import Line2D
-# print(Line2D.markers)
+ from matplotlib.lines import Line2D
+ print(Line2D.markers)
 
 """
 
@@ -26,6 +29,7 @@
 from PyQt5 import QtWidgets
 
 TIMESTAMP_LIMIT = datetime.datetime.fromisoformat("1990-01-01").timestamp()
+"""Earliest date for a run in any Bluesky catalog (1990-01-01)."""
 
 PLOT_COLORS = """
  r g b c m
@@ -48,8 +52,8 @@
 Do **NOT** sort these colors alphabetically! There should be obvious
 contrast between adjacent colors.
 
-.. seealso:: https://matplotlib.org/stable/gallery/color/named_colors.html
-.. seealso:: https://developer.mozilla.org/en-US/docs/Web/CSS/named-color
+* :see: https://matplotlib.org/stable/gallery/color/named_colors.html
+* :see: https://developer.mozilla.org/en-US/docs/Web/CSS/named-color
 """
 
 PLOT_SYMBOLS = """o + x * s d ^ v""".split()
@@ -61,9 +65,10 @@
  from matplotlib.lines import Line2D
  print(Line2D.markers)
 
-.. seealso:: https://matplotlib.org/stable/gallery/lines_bars_and_markers/marker_reference.html
+:see: https://matplotlib.org/stable/gallery/lines_bars_and_markers/marker_reference.html
 """
 
+# iterators for colors & symbols
 _AUTO_COLOR_CYCLE = cycle(PLOT_COLORS)
 _AUTO_SYMBOL_CYCLE = cycle(PLOT_SYMBOLS)
 

diff --git a/gemviz/select_fields_tablemodel.py b/gemviz/select_fields_tablemodel.py
@@ -25,7 +25,7 @@
 
  ~SelectFieldsTableModel
  ~ColumnDataType
- ~FieldSelectionRuleType
+ ~FieldRuleType
  ~TableColumn
  ~TableField
 """
@@ -90,31 +90,13 @@ class TableField:
  TableColumn("X", ColumnDataType.checkbox, rule=FieldRuleType.unique),
  TableColumn("Y", ColumnDataType.checkbox, rule=FieldRuleType.multiple),
 ]
-MDAVIZ_COLUMNS = XY_COLUMNS + [
- TableColumn("Mon", ColumnDataType.checkbox, rule=FieldRuleType.unique),
- TableColumn("Description", ColumnDataType.text),
- TableColumn("PV", ColumnDataType.text),
-]
 XY_FIELDS = [
  TableField("motor", "X", description="some motor"),
  TableField("I", "Y"),
  TableField("I00", "Y"),
  TableField("scint"),
  TableField("diode"),
 ]
-MDAVIZ_FIELDS = [
- TableField("time", description="epoch"),
- TableField("motor", "X", pv="ioc:m1"),
- TableField("I", "Y"),
- TableField("I0", "Mon", description="use as monitor", pv="ioc:I0"),
- TableField("I00", "Y"),
- TableField("I000"),
- TableField("scint"),
- TableField("diode"),
- TableField("ROI1"),
- TableField("ROI2"),
- TableField("ROI3"),
-]
 # fmt: on
 
 

diff --git a/gemviz/user_settings.py b/gemviz/user_settings.py
@@ -26,7 +26,7 @@
  For now, keep the windows on the main screen
  or learn how to edit the settings file.
 
-.. see:: https://github.com/prjemian/assign_gup/blob/master/src/Assign_GUP/settings.py
+:see:: https://github.com/prjemian/assign_gup/blob/master/src/Assign_GUP/settings.py
 
 .. autosummary::