fix small bugs + add sphinx documentation structure

.github/workflows/documentation.yml

@@ -16,6 +16,10 @@ jobs:
         run: |
           pip install sphinx sphinx_rtd_theme myst_parser
 
+      - name: Sphinx generate structure
+        run: |
+          sphinx-apidoc -o doc src
+
       - name: Sphinx build
         run: |
           sphinx-build doc _build

.gitignore

@@ -20,8 +20,9 @@ config.yml
 # caches
 **cache*
 
-# build files
+# build/dev directories
 dist/
+.grip/
 
 # large data & log folders
 _data/

README.template.md

@@ -101,7 +101,7 @@
     print(track1, track2, track3, album, playlist, artist)
     ```
 5. Add some tracks to a playlist in your library, synchronise with Spotify, and log the results
-   (assuming you chose to load your entire library or your just your playlists in step 3).
+   (assuming you chose to either load your entire library or just your playlists in step 3).
     ```python   
     my_playlist = library.playlists["<YOUR PLAYLIST'S NAME>"]
     my_playlist.append(track1)

_build/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 6f9d293138706817b2d16b1be9dff296
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_build/_sources/index.rst.txt

@@ -0,0 +1,20 @@
+.. Syncify documentation master file, created by
+   sphinx-quickstart on Fri Jan  5 21:58:01 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Syncify's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

_build/_sources/modules.rst.txt

@@ -0,0 +1,7 @@
+src
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   syncify

_build/_sources/syncify.abstract.rst.txt

@@ -0,0 +1,45 @@
+syncify.abstract package
+========================
+
+Submodules
+----------
+
+syncify.abstract.collection module
+----------------------------------
+
+.. automodule:: syncify.abstract.collection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.abstract.enums module
+-----------------------------
+
+.. automodule:: syncify.abstract.enums
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.abstract.misc module
+----------------------------
+
+.. automodule:: syncify.abstract.misc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.abstract.object module
+------------------------------
+
+.. automodule:: syncify.abstract.object
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: syncify.abstract
+   :members:
+   :undoc-members:
+   :show-inheritance:

_build/_sources/syncify.api.rst.txt

@@ -0,0 +1,21 @@
+syncify.api package
+===================
+
+Submodules
+----------
+
+syncify.api.exception module
+----------------------------
+
+.. automodule:: syncify.api.exception
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: syncify.api
+   :members:
+   :undoc-members:
+   :show-inheritance:

_build/_sources/syncify.local.library.rst.txt

@@ -0,0 +1,10 @@
+syncify.local.library package
+=============================
+
+Module contents
+---------------
+
+.. automodule:: syncify.local.library
+   :members:
+   :undoc-members:
+   :show-inheritance:

_build/_sources/syncify.local.playlist.rst.txt

@@ -0,0 +1,10 @@
+syncify.local.playlist package
+==============================
+
+Module contents
+---------------
+
+.. automodule:: syncify.local.playlist
+   :members:
+   :undoc-members:
+   :show-inheritance:

_build/_sources/syncify.local.rst.txt

@@ -0,0 +1,39 @@
+syncify.local package
+=====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   syncify.local.library
+   syncify.local.playlist
+   syncify.local.track
+
+Submodules
+----------
+
+syncify.local.collection module
+-------------------------------
+
+.. automodule:: syncify.local.collection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.local.exception module
+------------------------------
+
+.. automodule:: syncify.local.exception
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: syncify.local
+   :members:
+   :undoc-members:
+   :show-inheritance:

_build/_sources/syncify.local.track.rst.txt

@@ -0,0 +1,10 @@
+syncify.local.track package
+===========================
+
+Module contents
+---------------
+
+.. automodule:: syncify.local.track
+   :members:
+   :undoc-members:
+   :show-inheritance:

_build/_sources/syncify.processors.rst.txt

@@ -0,0 +1,69 @@
+syncify.processors package
+==========================
+
+Submodules
+----------
+
+syncify.processors.base module
+------------------------------
+
+.. automodule:: syncify.processors.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.processors.compare module
+---------------------------------
+
+.. automodule:: syncify.processors.compare
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.processors.exception module
+-----------------------------------
+
+.. automodule:: syncify.processors.exception
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.processors.limit module
+-------------------------------
+
+.. automodule:: syncify.processors.limit
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.processors.match module
+-------------------------------
+
+.. automodule:: syncify.processors.match
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.processors.sort module
+------------------------------
+
+.. automodule:: syncify.processors.sort
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.processors.time module
+------------------------------
+
+.. automodule:: syncify.processors.time
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: syncify.processors
+   :members:
+   :undoc-members:
+   :show-inheritance:

_build/_sources/syncify.remote.processors.rst.txt

@@ -0,0 +1,37 @@
+syncify.remote.processors package
+=================================
+
+Submodules
+----------
+
+syncify.remote.processors.check module
+--------------------------------------
+
+.. automodule:: syncify.remote.processors.check
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.remote.processors.search module
+---------------------------------------
+
+.. automodule:: syncify.remote.processors.search
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+syncify.remote.processors.wrangle module
+----------------------------------------
+
+.. automodule:: syncify.remote.processors.wrangle
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: syncify.remote.processors
+   :members:
+   :undoc-members:
+   :show-inheritance: