cleanup source docs

docs/conf.py

@@ -52,3 +52,7 @@ html_theme = 'sphinx_rtd_theme'
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+
+# Do not show full module path in api docs
+add_module_names = False
+python_use_unqualified_type_names = True

tools/docs

@@ -1,3 +1,4 @@
-sphinx-apidoc -o docs/source ytdl_subscribe
+# Uncomment to build api docs
-sphinx-build -b html docs docs/_html
+sphinx-apidoc -f -o docs/source ytdl_subscribe
+sphinx-build -a -b html docs docs/_html
 

ytdl_subscribe/subscriptions/subscription.py

@@ -298,9 +298,10 @@ class Subscription(Generic[SourceT, EntryT], ABC):
         """
         After downloading an entry to the working directory, perform all post-processing, which
         includes:
-          - Adding metadata to the entry file itself (music tags)
+
-          - Moving the entry file + thumbnail to the output directory with its formatted name
+        * Adding metadata to the entry file itself (music tags)
-          - Creating new metadata files (NFO) to reside alongside the entry files
+        * Moving the entry file + thumbnail to the output directory with its formatted name
+        * Creating new metadata files (NFO) to reside alongside the entry files
 
         :param entry: The entry to post-process
         """

ytdl_subscribe/ytdl_additions/enhanced_download_archive.py

@@ -180,22 +180,23 @@ class EnhancedDownloadArchive:
 
     1. self.prepare_download_archive()
         Internally calls...
+
         a. self._load()
-            - Checks the output directory to see if an existing enhanced download archive file
+           Checks the output directory to see if an existing enhanced download archive file
-              exists. If so, load it into the class. Otherwise, initialize an empty instance of one.
+           exists. If so, load it into the class. Otherwise, initialize an empty instance of one.
         b. self._copy_to_working_directory()
-            - If the download archive was loaded successfully, create a ytdl download archive in the
+           If the download archive was loaded successfully, create a ytdl download archive in the
-              working directory. This will let ytdl know which files are already downloaded.
+           working directory. This will let ytdl know which files are already downloaded.
     2. ( Perform the ytdlp download using a download archive with the same name )
-        - An existing archive should have been copied into the working directory for reuse
+        a. An existing archive should have been copied into the working directory for reuse
     3. self.mapping.add_entry(entry, file_path)
-        - Should be called for any file created for the given entry that gets moved to the output
+        a. Should be called for any file created for the given entry that gets moved to the output
-          directory
+           directory
     4. OPTIONAL: self.remove_stale_files()
-        - After all files have been moved over in the output directory, remove any stale files that
+        a. After all files have been moved over in the output directory, remove any stale files that
-          exist in there.
+           exist in there.
     5. self.save_download_archive()
-        - Save the updated mapping file to the output directory.
+        a. Save the updated mapping file to the output directory.
     6. ( Delete the working directory )
     """