From 92d318b4c6ef5c66707b948a661d91cfdbf217fa Mon Sep 17 00:00:00 2001 From: Qualis Svagtlys <45446348+Svagtlys@users.noreply.github.com> Date: Mon, 18 Dec 2023 20:50:56 -0600 Subject: [PATCH] Create advanced config page --- docs/source/{ => code_reference}/config.rst | 4 ++-- docs/source/code_reference/index.rst | 7 +++++++ docs/source/deprecation_notices.rst | 2 +- .../advanced_configuration.rst | 21 +++++++++++++++++++ docs/source/guides/getting_started/index.rst | 3 +++ docs/source/index.rst | 2 +- 6 files changed, 35 insertions(+), 4 deletions(-) rename docs/source/{ => code_reference}/config.rst (99%) create mode 100644 docs/source/code_reference/index.rst create mode 100644 docs/source/guides/getting_started/advanced_configuration.rst diff --git a/docs/source/config.rst b/docs/source/code_reference/config.rst similarity index 99% rename from docs/source/config.rst rename to docs/source/code_reference/config.rst index 8afa014a..db4af647 100644 --- a/docs/source/config.rst +++ b/docs/source/code_reference/config.rst @@ -367,7 +367,7 @@ parent preset: File Preset ~~~~~~~~~~~ -NOTE: This is deprecated in favor of using the method in :ref:`config:beautifying subscriptions`. +NOTE: This is deprecated in favor of using the method in :ref:`code_reference/config:beautifying subscriptions`. You can apply a preset to all subscriptions in the ``subscription.yaml`` file by using the file-wide ``__preset__``: @@ -389,7 +389,7 @@ subscriptions automatically set ``__preset__`` as a `parent preset`_. Subscription Value ~~~~~~~~~~~~~~~~~~~ -NOTE: This is deprecated in favor of using the method in :ref:`config:beautifying subscriptions`. +NOTE: This is deprecated in favor of using the method in :ref:`code_reference/config:beautifying subscriptions`. With a clever config and use of ``__preset__``, your subscriptions can typically boil down to a name and url. You can set ``__value__`` to the name of an override variable, diff --git a/docs/source/code_reference/index.rst b/docs/source/code_reference/index.rst new file mode 100644 index 00000000..f0149fe8 --- /dev/null +++ b/docs/source/code_reference/index.rst @@ -0,0 +1,7 @@ +Code Reference +============== + +This section contains direct references to the code of ``ytdl-sub`` and information on how it functions. + +.. toctree:: + config \ No newline at end of file diff --git a/docs/source/deprecation_notices.rst b/docs/source/deprecation_notices.rst index 8be00274..c8df8b3e 100644 --- a/docs/source/deprecation_notices.rst +++ b/docs/source/deprecation_notices.rst @@ -7,7 +7,7 @@ Oct 2023 subscription preset and value ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The use of ``__value__`` will go away in Dec 2023 in favor of the method found in -:ref:`config:beautifying subscriptions`. ``__preset__`` will still be supported for the time being. +:ref:`code_reference/config:beautifying subscriptions`. ``__preset__`` will still be supported for the time being. July 2023 --------- diff --git a/docs/source/guides/getting_started/advanced_configuration.rst b/docs/source/guides/getting_started/advanced_configuration.rst new file mode 100644 index 00000000..d898bfe7 --- /dev/null +++ b/docs/source/guides/getting_started/advanced_configuration.rst @@ -0,0 +1,21 @@ +Advanced Configuration +====================== + +If the :doc:`prebuilt presets ` aren't suitable for your needs, you may want to set up an advanced configuration. + +Layout of a Config file +----------------------- + +The layout of the ``config.yaml`` file is relatively straightforward: + +.. code-block:: yaml + + presets: + + preset_name: + plugin1: + plugin1_option1: value1 + + +Modifying an Existing Preset +---------------------------- diff --git a/docs/source/guides/getting_started/index.rst b/docs/source/guides/getting_started/index.rst index 734482b4..1ce1a331 100644 --- a/docs/source/guides/getting_started/index.rst +++ b/docs/source/guides/getting_started/index.rst @@ -65,6 +65,8 @@ Now that you have installed ``ytdl-sub``, checked your skills, and gotten a bit :doc:`Step 4: Automating Downloads ` +:doc:`Advanced Configuration ` + Other docs that may be of use: :doc:`prebuilt_presets` @@ -80,5 +82,6 @@ Other docs that may be of use: first_sub first_download automating_downloads + advanced_configuration prebuilt_presets examples \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index af274667..3c58dde0 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,7 +6,7 @@ ytdl-sub User Guide introduction guides/index faq/index - config + code_reference/index presets usage deprecation_notices