Merge pull request #192 from bkemper24/main

minor doc updates for Sphinx

Author: bkemper24

doc/source/conf.py

@@ -47,15 +47,15 @@
 
 autosummary_generate = True
 numpydoc_show_class_members = False
-autodoc_default_flags = ['show-inheritance']
+autodoc_default_options = {'show-inheritance': True}
 autoclass_content = 'class'
 
 intersphinx_mapping = {
     'python': ('https://docs.python.org/', None),
     'pandas': ('http://pandas.pydata.org/pandas-docs/version/0.19.2/', None),
     'numpy': ('http://docs.scipy.org/doc/numpy/', None),
     'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
-    'matplotlib': ('http://matplotlib.sourceforge.net/', None)
+    'matplotlib': ('https://matplotlib.org/stable/', None),
 }
 
 # Add any paths that contain templates here, relative to this directory.
@@ -74,7 +74,7 @@
 
 # General information about the project.
 project = 'SWAT'
-copyright = '2016 SAS Institute Inc. All Rights Reserved.'
+copyright = '%Y SAS Institute Inc. All Rights Reserved.'
 author = 'SAS'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -94,7 +94,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -142,17 +142,17 @@
 
 html_theme = 'sphinx_rtd_theme'
 
-html_context = {
-    'css_files': ['_static/custom.css'],
-}
+# html_context = {
+#     'css_files': ['_static/custom.css'],
+# }
 
 # 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
 # documentation.
 # html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".

doc/source/getting-started.rst

@@ -261,7 +261,7 @@ synonyms for ``user``, and ``protocol`` is a synonym for ``port``.
 
 You can specify as many of the ``host`` lines as possible.  The ``port`` field
 is optional.  If it is left off, all ports will use the same password.
-Hostnames much match the hostname used in the :class:`CAS` constructor exactly.  It does
+Hostnames must match the hostname used in the :class:`CAS` constructor exactly.  It does
 not do any DNS expanding of the names.  So 'host1' and 'host1.my-company.com' are
 considered two different hosts.
 

swat/cas/connection.py

@@ -170,6 +170,8 @@ class CAS(object):
         User-definable name for the session.
     nworkers : int or long, optional
         Number of worker nodes to use.
+        This parameter is only valid
+        with the binary (not REST) protocol.
     authinfo : string or list-of-strings, optional
         The filename or list of filenames of authinfo/netrc files used
         for authentication.
@@ -240,7 +242,7 @@ class CAS(object):
     >>> conn = swat.CAS('mycashost.com', 5570, locale='es_US')
 
     To limit the number of worker nodes in a grid, you use the nworkers=
-    parameter.
+    parameter (binary protocol only).
 
     >>> conn = swat.CAS('mycashost.com', 5570, nworkers=4)
 
@@ -1142,7 +1144,7 @@ def del_results_hooks(self, name):
         Delete all post-processing functions for an action
 
         Parameters
-        ---------
+        ----------
         name : string
            Full name of action (actionset.actionname)
 

swat/cas/datamsghandlers.py

@@ -1183,7 +1183,8 @@ def getrow(self, row):
 
 
 class Image(CASDataMsgHandler):
-    """CAS data message handler for images.
+    '''
+    Create an Image data message handler.
 
     Parameters
     ----------
@@ -1220,8 +1221,7 @@ class Image(CASDataMsgHandler):
     behavior should be similar to that of the image.loadImages_ CAS action for loading
     server-side images:
 
-    .. _image.loadImages: https://go.documentation.sas.com/doc/en/pgmsascdc/v_028/casactml/casactml_image_details22
-    .htm  # noqa: E501
+    .. _image.loadImages: https://go.documentation.sas.com/doc/en/pgmsascdc/v_028/casactml/casactml_image_details22.htm
 
     Although images will be stored in binary format to a CAS table column
     labeled "_image_", the CAS table metadata will not indicate that this column should
@@ -1236,7 +1236,8 @@ class Image(CASDataMsgHandler):
     >>> conn.addtable(table='mytable', **dmh.args.addtable).casTable
     ... CASTable('MYTABLE', caslib='CASUSER(user)')
 
-    """
+    '''   # noqa: E501
+
     def __init__(self, data, nrecs=1000, subdirs=True):
         # To maintain Py2.7 compatibility, use strings instead of Paths.
         if type(data).__module__ == 'pathlib':

swat/cas/table.py

@@ -5886,14 +5886,14 @@ def drop_duplicates(self, casout, subset=[]):
         a subset of columns when checking for duplicate rows.
 
         Parameters
-        --------
+        ----------
         casout : string or :class:`CASTable` or dict
             The output table.
         subset : string or list-of-strings, optional
             The subset of columns to consider when checking for duplicate rows.
 
         Returns
-        --------
+        -------
         :class:`CASTable`
             The input table without duplicate rows.
         '''