misc(docs): testing some changes to hopefully get docstrings working

docs/source/api.rst

@@ -5,3 +5,15 @@ API Reference
    :toctree: generated
 
    pyzipline
+
+
+.. automodule:: zipline
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+   :noindex:
+   :exclude-members: __init__, __repr__, __str__
+
+   .. automethod:: zipline.function_name
+      :noindex:

docs/source/conf.py

@@ -1,3 +1,4 @@
+# pylint: skip-file
 # Configuration file for the Sphinx documentation builder.
 
 # -- Project information

pyzipline/zipline.py

@@ -16,14 +16,14 @@ class ZiplineApi:
 
         :param hostname: The hostname of your Zipline instance, WITHOUT https or http.
         :type hostname: str
-        :param token: (optional) String used for authentication when making requests.
+        :param token: String used for authentication when making requests.
-        :type token: str
+        :type token: str, optional
-        :param ssl: (optional) Normally set to True, but if your Zipline instance doesn't use SSL/TLS, set this to False.
+        :param ssl: Normally set to True, but if your Zipline instance doesn't use SSL/TLS, set this to False.
-        :type ssl: bool
+        :type ssl: bool, optional
-        :param enforced_signing: (optional) Normally set to True, but if having SSL/TLS cert validation issues, can turn off with False.
+        :param enforced_signing: Normally set to True, but if having SSL/TLS cert validation issues, can turn off with False.
-        :type enforced_signing: bool
+        :type enforced_signing: bool, optional
-        :param logger: (optional) If your app has a logger, pass it in here.
+        :param logger: If your app has a logger, pass it in here.
-        :type logger: logging.Logger
+        :type logger: logging.Logger, optional
         """
         self._rest_adapter = RestAdapter(hostname=hostname, token=token, ssl=ssl, enforced_signing=enforced_signing, logger=logger)
 
@@ -32,8 +32,8 @@ class ZiplineApi:
 
         :param user_id: Integer ID of the user
         :type user_id: int
-        :return: User object
+        :return: The :class:`pyzipline.models.User` object matching the ID
-        :rtype: User
+        :rtype: :class:`pyzipline.models.User`
         """
         result = self._rest_adapter.get(endpoint=f"user/{user_id}")
         return User(**result.data)
@@ -41,8 +41,8 @@ class ZiplineApi:
     def get_self(self) -> User:
         """Get the currently authenticated user
 
-        :return: User object
+        :return: `pyzipline.models.User`object matching the authenticated user
-        :rtype: User
+        :rtype: `pyzipline.models.User`
         """
         result = self._rest_adapter.get(endpoint=f"user")
         return User(**result.data)