Add parameter type hinting to API reference

CHANGELOG.md

@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   Integration tests via GHA (non-user endpoints)
 -   Unit tests for new releases, passing limit parameter with minimum and maximum values of 1 and 50
 -   Unit tests for categories, omitting country code to test global releases
+-   Added basic built-in type hints to `client.py` methods
+-   Added [sphinx-autodoc-typehints](https://github.com/tox-dev/sphinx-autodoc-typehints) package to automatically build documentation based on type annotations in client.py
 
 ### Fixed
 

docs/conf.py

@@ -11,14 +11,15 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import spotipy
+import sys
+import os
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #sys.path.insert(0, os.path.abspath('.'))
 sys.path.insert(0, os.path.abspath('.'))
-import spotipy
 
 # -- General configuration -----------------------------------------------------
 
@@ -27,7 +28,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc']
+extensions = ['sphinx.ext.autodoc', 'sphinx_autodoc_typehints']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -172,21 +173,21 @@
 # -- Options for LaTeX output --------------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'spotipy.tex', 'spotipy Documentation',
-   'Paul Lamere', 'manual'),
+    ('index', 'spotipy.tex', 'spotipy Documentation',
+     'Paul Lamere', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -229,9 +230,9 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'spotipy', 'spotipy Documentation',
-   'Paul Lamere', 'spotipy', 'One line description of project.',
-   'Miscellaneous'),
+    ('index', 'spotipy', 'spotipy Documentation',
+     'Paul Lamere', 'spotipy', 'One line description of project.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.