doc: cleanup

Author: jlwalke2

doc/api/services/report_images.rst

@@ -3,4 +3,5 @@ sasctl.services.report_images
 
 .. automodule:: sasctl._services.report_images
     :members:
-    :undoc-members:
+    :undoc-members:
+    :show-inheritance:

doc/api/services/reports.rst

@@ -4,3 +4,4 @@ sasctl.services.reports
 .. automodule:: sasctl._services.reports
     :members:
     :undoc-members:
+    :show-inheritance:

doc/conf.py

@@ -55,8 +55,8 @@
     "pytest": ("https://docs.pytest.org/en/latest/", None),
     "betamax": ("https://betamax.readthedocs.io/en/latest/", None),
     "requests": ("https://2.python-requests.org/en/master/", None),
-    "tox": ("https://tox.readthedocs.io/en/latest/", None),
-    "flake8": ("http://flake8.pycqa.org/en/latest/", None),
+    "tox": ("https://tox.wiki/en/latest/objects.inv", None),
+    "flake8": ("https://flake8.pycqa.org/en/latest/objects.inv", None),
 }
 
 autosummary_generate = True

src/sasctl/_services/cas_management.py

@@ -93,7 +93,7 @@ def list_sessions(cls, query_params: dict = None, server: str = None):
         Returns a collection of sessions available on the CAS server.
 
         Parameters
-        ------
+        ----------
         query_params : dict, optional
             Query parameters.
             Valid keys are `start`, `limit`, `filter`,
@@ -129,7 +129,7 @@ def create_session(cls, properties: dict, server: str = None):
         """Creates a new session on the CAS server.
 
         Parameters
-        ------
+        ----------
         properties : dict
             Properties of the session.
             Valid keys are `authenticationType` (required),
@@ -164,7 +164,7 @@ def delete_session(
         """Terminates a session on the CAS server.
 
         Parameters
-        ------
+        ----------
         sess_id : str
             A string indicating the Session id.
         server : str

src/sasctl/_services/data_sources.py

@@ -40,7 +40,7 @@ def get_provider(cls, provider, refresh=False):
             A dictionary containing the provider attributes or None.
 
         Notes
-        -------
+        -----
         If `provider` is a complete representation of the provider it will be
         returned unless `refresh` is set.  This prevents unnecessary REST calls
         when data is already available on the client.

src/sasctl/_services/service.py

@@ -229,7 +229,7 @@ def get_item(cls, item, refresh=False):
                 A dictionary containing the {item} attributes or None.
 
             Notes
-            -------
+            -----
             If `item` is a complete representation of the {item} it will be
             returned unless `refresh` is set.  This prevents unnecessary REST
             calls when data is already available on the client.

src/sasctl/core.py

@@ -2032,7 +2032,7 @@ def request(verb, path, session=None, format="auto", **kwargs):
 
     Returns
     -------
-
+    str, bytes, or requests.Response
     """
     session = session or current_session()
 
@@ -2111,10 +2111,11 @@ def request_link(obj, rel, **kwargs):
     obj : dict
     rel : str
     kwargs : any
-        Passed to :function:`request`
+        Passed to :func:`request`
 
     Returns
     -------
+    RestObj
 
     """
     link = get_link(obj, rel)

tox.ini

@@ -58,6 +58,8 @@ deps =
 #    tests: lightgbm ; platform_system != "Darwin"  # lightgmb seems to have build issues on MacOS
 # doc skips install, so explicitly add minimum packages
     doc: sphinx
+    doc: numpydoc
+    doc: pydata-sphinx-theme
     doc: pyyaml
 
 setenv =