major doc refactoring underway

docs/config/examples/kodi_tv_shows.rst

@@ -1,12 +0,0 @@
-Kodi/Jellyfin TV Shows
-======================
-
-Config
-
-.. include:: ../../../examples/kodi_tv_shows_config.yaml
-   :literal:
-
-
-
-.. include:: ../../../examples/kodi_tv_shows_subscriptions.yaml
-   :literal:

docs/config/format_variables/index.rst

@@ -1,11 +0,0 @@
-Format Variables
-================
-
-Hello, WIP
-
-.. toctree::
-   :titlesonly:
-   :maxdepth: 2
-
-   soundcloud
-   youtube

docs/config/format_variables/soundcloud.rst

@@ -1,7 +0,0 @@
-Soundcloud Track
-----------------
-
-.. automodule:: ytdl_sub.entries.variables.soundcloud_variables
-   :members:
-   :inherited-members:
-   :undoc-members:

docs/config/format_variables/youtube.rst

@@ -1,7 +0,0 @@
-Youtube Video
--------------
-
-.. automodule:: ytdl_sub.entries.variables.youtube_variables
-   :members:
-   :inherited-members:
-   :undoc-members:

docs/config/index.rst

@@ -1,41 +1,100 @@
 Configuration
 =============
+ytdl-sub is configured in the ``config.yaml`` and consists of two sections:
 
+.. code-block:: yaml
 
-Source and Download Strategy
-----------------------------
+   configuration:
+   presets:
+
+The ``configuration`` section contains app-wide configs.
+
+Presets
+-------
+
+``presets`` define a `formula` for how to format downloaded media and metadata.
+
+Required: Source Download Strategy
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Download strategies dictate what exactly is getting downloaded from which
 source. By having separate strategies, we can define strategy-dependent
 parameters to better fine-tune how we download things.
 
 youtube: channel
-^^^^^^^^^^^^^^^^
+""""""""""""""""
+.. code-block:: yaml
+
+   presets:
+     my_example_preset:
+       youtube:
+         download_strategy: "channel"
+
 .. autoclass:: ytdl_sub.downloaders.youtube_downloader.YoutubeChannelDownloaderOptions()
    :members:
    :inherited-members:
+   :member-order: bysource
    :exclude-members: get_date_range
 
 youtube: playlist
-^^^^^^^^^^^^^^^^^
+"""""""""""""""""
+.. code-block:: yaml
+
+   presets:
+     my_example_preset:
+       youtube:
+         download_strategy: "playlist"
+
 .. autoclass:: ytdl_sub.downloaders.youtube_downloader.YoutubePlaylistDownloaderOptions()
    :members:
    :inherited-members:
 
 youtube: video
-^^^^^^^^^^^^^^
+""""""""""""""
+.. code-block:: yaml
+
+   presets:
+     my_example_preset:
+       youtube:
+         download_strategy: "video"
+
 .. autoclass:: ytdl_sub.downloaders.youtube_downloader.YoutubeVideoDownloaderOptions()
    :members:
    :inherited-members:
 
 soundcloud: albums_and_singles
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+""""""""""""""""""""""""""""""
+.. code-block:: yaml
+
+   presets:
+     my_example_preset:
+       soundcloud:
+         download_strategy: "albums_and_singles"
+
 .. autoclass:: ytdl_sub.downloaders.soundcloud_downloader.SoundcloudAlbumsAndSinglesDownloadOptions()
    :members:
    :inherited-members:
 
-.. toctree::
-   :titlesonly:
-   :maxdepth: 2
+Format Variables
+----------------
+Format variables are ``{variables}`` that contain metadata from downloaded
+media.
+
+.. contents:: Source Format Variables
+   :local:
+
+Youtube Variables
+^^^^^^^^^^^^^^^^^
+
+.. automodule:: ytdl_sub.entries.variables.youtube_variables
+   :members:
+   :inherited-members:
+   :undoc-members:
+
+Soundcloud Variables
+^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: ytdl_sub.entries.variables.soundcloud_variables
+   :members:
+   :inherited-members:
+   :undoc-members:
 
-   format_variables/index
-   examples/index

docs/examples/kodi_tv_shows.rst

@@ -0,0 +1,12 @@
+Kodi/Jellyfin TV Shows
+======================
+
+Config
+
+.. include:: ../../examples/kodi_tv_shows_config.yaml
+   :literal:
+
+
+
+.. include:: ../../examples/kodi_tv_shows_subscriptions.yaml
+   :literal:

docs/getting_started/usage_ideas.rst

@@ -24,5 +24,5 @@ prefer.
     * Add tags and album cover images so it shows up nicely in your music player
 
 If you want to jump the gun to see how ytdl-sub can be configured to do these things, head over to the
-:doc:`examples <../config/examples/index>`.
+:doc:`examples <../examples/index>`.
 

docs/index.rst

@@ -14,8 +14,8 @@ Contents
 ========
 
 .. toctree::
-   :titlesonly:
-   :maxdepth: 2
+   :maxdepth: 3
 
    getting_started/index
    config/index
+   examples/index