DOC: Fix inheritance diagram for Ginga API.

pllim · pllim · commit 678a2e44a927 · 2021-02-23T12:28:08.000-05:00
DOC: Cannot use automodapi for Ginga API because we need to inherit docstring.

DOC: Do not display inherited members because too confusing.

[ci skip]
diff --git a/astrowidgets/ginga.py b/astrowidgets/ginga.py
@@ -1,4 +1,5 @@
-"""Module containing ``astrowidgets`` implemented with Ginga backend.
+"""The ``astrowidgets.ginga`` module contains a widget implemented with the
+Ginga backend.
 
 For this to work, ``astrowidgets`` must be installed along with the optional
 dependencies specified for the Ginga backend; e.g.,::
diff --git a/docs/conf.py b/docs/conf.py
@@ -45,6 +45,8 @@
 
 # -- General configuration ----------------------------------------------------
 
+autodoc_inherit_docstrings = True
+
 # By default, highlight as Python 3.
 highlight_language = 'python3'
 
diff --git a/docs/ginga.rst b/docs/ginga.rst
@@ -90,4 +90,10 @@ For more details, see `this discussion of opencv and astrowidgets
 API
 ---
 
-.. automodapi:: astrowidgets.ginga
+.. automodule:: astrowidgets.ginga
+
+.. inheritance-diagram:: astrowidgets.ginga.ImageWidget
+    :top-classes: ipywidgets.VBox, astrowidgets.core.BaseImageWidget
+
+.. autoclass:: astrowidgets.ginga.ImageWidget
+    :members:
