a642028d7b
This is another change that touches the generated docs, so after finishing my writing, I
copied the change to `./docs/source/config_reference/scripting/static_variables.rst`
into the corresponding docstring in
`./src/ytdl_sub/entries/variables/override_variables.py` and formatted it as a
docstring. Then I ran:
$ REGENERATE_DOCS=1 tox exec -e "py" -- pytest tests/unit/docgen/test_docgen.py
But all that did was revert the changes to
`./docs/source/config_reference/scripting/static_variables.rst`. IOW, it did *not*
update the rST from the changed docstring.
103 lines
2.8 KiB
ReStructuredText
103 lines
2.8 KiB
ReStructuredText
..
|
|
WARNING: This RST file is generated from docstrings in:
|
|
src/ytdl_sub/entries/variables/override_variables.py
|
|
In order to make a change to this file, edit the respective docstring
|
|
and run `make docs`. This will automatically sync the Python RST-based
|
|
docstrings into this file. If the docstrings and RST file are out of sync,
|
|
it will fail TestDocGen tests in GitHub CI.
|
|
|
|
Static Variables
|
|
================
|
|
|
|
Subscription Variables
|
|
----------------------
|
|
|
|
subscription_array
|
|
~~~~~~~~~~~~~~~~~~
|
|
For subscriptions in the form of
|
|
|
|
.. code-block:: yaml
|
|
|
|
"Subscription Name":
|
|
- "https://url1.com/..."
|
|
- "https://url2.com/..."
|
|
|
|
Store all values into an array named ``subscription_array``.
|
|
|
|
subscription_has_download_archive
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Returns True if the subscription has any entries recorded in a download archive. False
|
|
otherwise.
|
|
|
|
subscription_indent_i
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
For subscriptions where the ancestor keys contain the ``= ...`` prefix, the
|
|
variables ``subscription_indent_1``, ``subscription_indent_2``, and so on get
|
|
set to each subsequent value. For example, given the following subscriptions
|
|
file snippet:
|
|
|
|
.. code-block:: yaml
|
|
|
|
Preset 1 | = Indent Value 1 | Preset 2:
|
|
Preset 3 | = Indent Value 2 | Preset 4:
|
|
"Subscription Name": "https://..."
|
|
|
|
The ``{subscription_indent_1}`` variable will be ``Indent Value 1`` and
|
|
``{subscription_indent_2}`` will be ``Indent Value 2``. The most common use of
|
|
these variables is to :doc:`set the genre and rating for subscriptions from the
|
|
YAML keys <../prebuilt_presets/tv_show>`.
|
|
|
|
subscription_map
|
|
~~~~~~~~~~~~~~~~
|
|
For subscriptions in the form of
|
|
|
|
.. code-block:: yaml
|
|
|
|
+ Subscription Name:
|
|
Music Videos:
|
|
- "https://url1.com/..."
|
|
Concerts:
|
|
- "https://url2.com/..."
|
|
|
|
Stores all the contents under the subscription name into the override variable
|
|
``subscription_map`` as a Map value. The above example is stored as:
|
|
|
|
.. code-block:: python
|
|
|
|
{
|
|
"Music Videos": [
|
|
"https://url1.com/..."
|
|
],
|
|
"Concerts: [
|
|
"https://url2.com/..."
|
|
]
|
|
}
|
|
|
|
subscription_name
|
|
~~~~~~~~~~~~~~~~~
|
|
Name of the subscription. For subscriptions types that use a prefix (``~``, ``+``),
|
|
the prefix and all whitespace afterwards is stripped from the subscription name.
|
|
|
|
subscription_value
|
|
~~~~~~~~~~~~~~~~~~
|
|
For subscriptions in the form of
|
|
|
|
.. code-block:: yaml
|
|
|
|
"Subscription Name": "https://..."
|
|
|
|
``subscription_value`` gets set to ``https://...``.
|
|
|
|
subscription_value_i
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
For subscriptions in the form of
|
|
|
|
.. code-block:: yaml
|
|
|
|
"Subscription Name":
|
|
- "https://url1.com/..."
|
|
- "https://url2.com/..."
|
|
|
|
``subscription_value_1`` and ``subscription_value_2`` get set to ``https://url1.com/...``
|
|
and ``https://url2.com/...``. Note that ``subscription_value_1`` also gets set to
|
|
``subscription_value``.
|