Create advanced config page
This commit is contained in:
parent
4499ed8a36
commit
92d318b4c6
6 changed files with 35 additions and 4 deletions
|
|
@ -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,
|
||||
7
docs/source/code_reference/index.rst
Normal file
7
docs/source/code_reference/index.rst
Normal file
|
|
@ -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
|
||||
|
|
@ -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
|
||||
---------
|
||||
|
|
|
|||
|
|
@ -0,0 +1,21 @@
|
|||
Advanced Configuration
|
||||
======================
|
||||
|
||||
If the :doc:`prebuilt presets </guides/getting_started/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
|
||||
----------------------------
|
||||
|
|
@ -65,6 +65,8 @@ Now that you have installed ``ytdl-sub``, checked your skills, and gotten a bit
|
|||
|
||||
:doc:`Step 4: Automating Downloads <automating_downloads>`
|
||||
|
||||
:doc:`Advanced Configuration <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
|
||||
|
|
@ -6,7 +6,7 @@ ytdl-sub User Guide
|
|||
introduction
|
||||
guides/index
|
||||
faq/index
|
||||
config
|
||||
code_reference/index
|
||||
presets
|
||||
usage
|
||||
deprecation_notices
|
||||
|
|
|
|||
Loading…
Reference in a new issue