bye examples

This commit is contained in:
Jesse Bannon 2024-11-30 08:00:14 -08:00
parent a77f1beb77
commit c39fcdc254
3 changed files with 13 additions and 20 deletions

View file

@ -1,15 +0,0 @@
=====================
Using Example Configs
=====================
Copy and paste the examples into local yaml files, modify the
``working_directory`` and ``output_directory`` with your desired paths,
and perform a dry-run using
.. code-block:: bash
ytdl-sub \
--dry-run \
--config path/to/config.yaml \
sub path/to/subscriptions.yaml
This will simulate what a download will look like.

View file

@ -29,11 +29,22 @@ Having many subscriptions could still make this dry run take a while. A subset o
subscriptions can be dry ran using a match.
.. code-block:: shell
:caption: Only run subscriptions that have PBS in their names
ytdl-sub --dry-run sub subscriptions.yaml -o '--ytdl_options.max_downloads 3' --match PBS
Downloading
-----------
WIP
Once the subscriptions file is validated, a download can be performed by omitting the dry run argument.
.. code-block:: shell
ytdl-sub sub subscriptions.yaml
Multiple subscription file names can be provided to perform a download on all of them. A single file
named ``subscriptions.yaml`` does not require a file name specification since it will
look for that file name by default, making the following command valid.
.. code-block:: shell
ytdl-sub sub

View file

@ -68,8 +68,6 @@ Other docs that may be of use:
:doc:`/prebuilt_presets/index`
:doc:`examples`
.. toctree::
:hidden:
:caption: Getting Started Guide
@ -80,4 +78,3 @@ Other docs that may be of use:
automating_downloads
first_config
advanced_configuration
examples