danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(various): Minor typo and formatting fixes

Browse source
This commit is contained in:
Ross Patterson 2025-08-20 01:56:56 -07:00
parent 4bb96c4374
commit ca17441c57
No known key found for this signature in database
GPG key ID: 2EFF7CCE6828E359
3 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/source/guides/getting_started/index.rst
View file

@ -65,8 +65,8 @@ Plugins do the work
``ytdl-sub`` applies the plugins that the presets configure when it downloads a ``ytdl-sub`` applies the plugins that the presets configure when it downloads a
subscription. :doc:`The plugins <../../config_reference/plugins>` control how to run subscription. :doc:`The plugins <../../config_reference/plugins>` control how to run
``yt-dlp``, which media in the subscription to download, how to collect and format ``yt-dlp``, which media in the subscription to download, how to collect and format
metadata for those media, and how to place the resulting files into your media library, metadata for those media, how to place the resulting files into your media library, and
and more. more.
Presets and subscriptions accept overrides Presets and subscriptions accept overrides
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -101,7 +101,7 @@ The configuration file extends pre-defined presets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Users define additional presets in :doc:`their configuration file <./first_config>` that Users define additional presets in :doc:`their configuration file <./first_config>` that
they then use in most of their subscriptions. Most user-defines presets extend the they then use in most of their subscriptions. Most user-defined presets extend the
:doc:`../../prebuilt_presets/index` provided by ``ytdl-sub``. :doc:`../../prebuilt_presets/index` provided by ``ytdl-sub``.
Caveats Caveats

4
docs/source/guides/install/docker.rst
View file

@ -119,5 +119,5 @@ Configuration
In these examples, the configuration files will be at In these examples, the configuration files will be at
``<path/to/ytdl-sub/config>/config.yaml`` and ``<path/to/ytdl-sub/config>/config.yaml`` and
``<path/to/ytdl-sub/config>/subscriptions.yaml``. Starting the container the first time ``<path/to/ytdl-sub/config>/subscriptions.yaml``. Start the container the first time to
will populate those files with default examples. populate those files with default examples.

4
docs/source/introduction.rst
View file

@ -17,9 +17,13 @@ and how it should appear in your media library servers and applications such as
To these ends, ``ytdl-sub``: To these ends, ``ytdl-sub``:
- wraps and runs `yt-dlp`_, per your configuration to: - wraps and runs `yt-dlp`_, per your configuration to:
- download the media, remux and/or optionally transcode it - download the media, remux and/or optionally transcode it
- prepares additional metadata both embedded and in external files - prepares additional metadata both embedded and in external files
- renames the resulting files - renames the resulting files
- places them in your library - places them in your library
.. figure:: https://user-images.githubusercontent.com/10107080/182677243-b4184e51-9780-4094-bd40-ea4ff58555d0.PNG .. figure:: https://user-images.githubusercontent.com/10107080/182677243-b4184e51-9780-4094-bd40-ea4ff58555d0.PNG