From c39fcdc25485589a0804bed808a4665605562d8b Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Sat, 30 Nov 2024 08:00:14 -0800 Subject: [PATCH] bye examples --- docs/source/guides/getting_started/examples.rst | 15 --------------- .../guides/getting_started/first_download.rst | 15 +++++++++++++-- docs/source/guides/getting_started/index.rst | 3 --- 3 files changed, 13 insertions(+), 20 deletions(-) delete mode 100644 docs/source/guides/getting_started/examples.rst diff --git a/docs/source/guides/getting_started/examples.rst b/docs/source/guides/getting_started/examples.rst deleted file mode 100644 index 7045ef7b..00000000 --- a/docs/source/guides/getting_started/examples.rst +++ /dev/null @@ -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. \ No newline at end of file diff --git a/docs/source/guides/getting_started/first_download.rst b/docs/source/guides/getting_started/first_download.rst index 1a9c057e..188c5c32 100644 --- a/docs/source/guides/getting_started/first_download.rst +++ b/docs/source/guides/getting_started/first_download.rst @@ -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 \ No newline at end of file +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 diff --git a/docs/source/guides/getting_started/index.rst b/docs/source/guides/getting_started/index.rst index c8eb91c0..d38fe7de 100644 --- a/docs/source/guides/getting_started/index.rst +++ b/docs/source/guides/getting_started/index.rst @@ -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 \ No newline at end of file