Merge pull request #52 from pllim/change-html-theme

Improve doc

docs/source/conf.py

@@ -104,7 +104,7 @@
 pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+modindex_common_prefix = ['stginga.']
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
 #keep_warnings = False
@@ -117,7 +117,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/source/index.rst

@@ -51,6 +51,7 @@ Using ``stginga``
 .. toctree::
    :maxdepth: 2
 
+   plugins
    ref_api
 
 
@@ -59,5 +60,3 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
-

docs/source/plugins.rst

@@ -0,0 +1,95 @@
+.. _stginga-plugins:
+
+Plugins
+=======
+
+By using ``stginga``, the following plugins (in alphabetical order) are also
+available, in addition to the ones that already come with Ginga. Some are
+customizable via plugin configuration files, which are available in the
+`stginga/examples/configs <https://github.com/spacetelescope/stginga/tree/master/stginga/examples/configs>`_ directory.
+
+
+.. _local-plugin-backgroundsub:
+
+BackgroundSub
+-------------
+
+This plugin is used to calculate and subtract background value. Currently,
+it only handles constant background and there is no way to save the subtracted
+image. However, subtraction parameters can be saved to a JSON file, which then
+can be reloaded as well.
+
+.. image:: _static/backgroundsub_screenshot.png
+  :width: 800px
+  :alt: BackgroundSub plugin
+
+It is customizable using ``~/.ginga/plugin_BackgroundSub.cfg``::
+
+  #
+  # BackgroundSub plugin preferences file
+  #
+  # Place this in file under ~/.ginga with the name "plugin_BackgroundSub.cfg"
+
+  # Color of the background region outline and label
+  bgsubcolor = 'magenta'
+
+  # Default background region properties. Can also be changed in the GUI.
+  # bgtype can be 'annulus', 'box', or 'constant'
+  bgtype = 'annulus'
+  annulus_width = 10
+
+  # Default calculation parameters. Can also be changed in the GUI.
+  # algorithm can be 'mean', 'median', or 'mode'
+  algorithm = 'median'
+  sigma = 1.8
+  niter = 10
+
+
+.. _local-plugin-dqinspect:
+
+DQInspect
+---------
+
+This plugin is used to inspect the associated DQ array of a given image.
+It shows the different DQ flags that went into a given pixel (middle right)
+and also the overall mask of the selected DQ flag(s) (bottom right).
+
+.. image:: _static/dqinspect_screenshot.png
+  :width: 800px
+  :alt: DQInspect plugin
+
+It is customizable using ``~/.ginga/plugin_DQInspect.cfg``::
+
+  #
+  # DQInspect plugin preferences file
+  #
+  # Place this in file under ~/.ginga with the name "plugin_DQInspect.cfg"
+
+  # Display long or short descriptions
+  dqstr = 'long'
+
+  # DQ definition files (JWST)
+  dqdict = {'NIRCAM': 'data/dqflags_jwst.txt', 'NIRSPEC': ...}
+
+  # Color to mark a single pixel for inspection
+  pxdqcolor = 'red'
+
+  # Color and opacity to mark all affected pixels
+  imdqcolor = 'blue'
+  imdqalpha = 1.0
+
+
+.. _local-plugin-mipick:
+
+MIPick
+------
+
+TBD
+
+
+.. _local-plugin-multiimage:
+
+MultiImage
+----------
+
+TBD

docs/source/ref_api.rst

@@ -1,15 +1,15 @@
 Reference/API
 =============
 
-``stginga.gingawrapper``
-------------------------
+gingawrapper
+------------
 
 .. automodule:: stginga.gingawrapper
   :members:
 
 
-``stginga.utils``
------------------
+utils
+-----
 
 .. automodule:: stginga.utils
   :members: