60ff645750
I've been running into variations in style in the docs I've edited so far. I've been including changes for consistency in with other commits but in many cases that makes one part of one doc more consistent with the rest but less consistent with itself. It seems like a bit of cleanup may be in order. This change applies the following conventions: - Section heading heirarchy: #. ``=`` with overline for document title, IOW first heading #. ``-`` #. ``~`` #. ``"`` - Two newlines before ``-`` sections for readability - A newline between every section of any level and the first line of text - Wrap paragraph lines at 88 characters to match Python's Black I've only applied these changes to those ``*.rst`` files that aren't generated. In the future, I might suggest another bulk change to match [the Sphinx conventions for section headings](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections).
51 lines
1.8 KiB
ReStructuredText
51 lines
1.8 KiB
ReStructuredText
=========
|
|
Reference
|
|
=========
|
|
|
|
This section contains direct references to the code of ``ytdl-sub`` and information on
|
|
how it functions.
|
|
|
|
|
|
Terminology
|
|
-----------
|
|
|
|
Must-know terminology:
|
|
|
|
- ``subscription``: URL(s) that you want to download with specific metadata
|
|
requirements.
|
|
- ``preset``: A media profile comprised of YAML configuration that can specify anything
|
|
from metadata layout, media quality, or any feature of ytdl-sub, to apply to
|
|
subscriptions. A preset can inherit other presets.
|
|
- ``prebuilt preset``: Presets that are included in ytdl-sub. These do most of the work
|
|
defining plugins, overrides, etc in order to make downloads ready for player
|
|
consumption.
|
|
- ``override``: Verb describing the act of overriding something in a preset. For
|
|
example, the TV Show presets practically expect you to *override* the URL variable to
|
|
tell ytdl-sub where to download from.
|
|
- ``override variables``: User-defined variables that are intended to *override*
|
|
something.
|
|
- ``subscription file``: The file to specify all of your subscriptions and some override
|
|
variables.
|
|
|
|
Intermediate terminology:
|
|
|
|
- ``plugin``: Modular logic to apply to a subscription. To use a plugin, it must be
|
|
defined in a preset.
|
|
- ``config file``: An optional file where you can define custom presets and other
|
|
advanced configuration.
|
|
- ``yt-dlp``: The underlying application that handles downloading for ytdl-sub.
|
|
|
|
Advanced terminology:
|
|
|
|
- ``entry variables``: Variables that derive from a downloaded yt-dlp entry (media).
|
|
- ``static variables``: Variables that do not have a dependency to entry variables.
|
|
- ``scripting``: Syntax that allows the use of entry variables, static variables, and
|
|
functions in override variables.
|
|
|
|
|
|
.. toctree::
|
|
config_yaml
|
|
subscription_yaml
|
|
plugins
|
|
scripting/index
|
|
prebuilt_presets/index
|