diff --git a/docs/source/faq/index.rst b/docs/source/faq/index.rst index 8b85f21a..bb5f4fe0 100644 --- a/docs/source/faq/index.rst +++ b/docs/source/faq/index.rst @@ -41,8 +41,8 @@ download your YouTube cookie, then add it to your :ref:`ytdl options ...automate my downloads? ~~~~~~~~~~~~~~~~~~~~~~~~~ -:doc:`This page ` shows how to set up ``ytdl-sub`` -to run automatically on various platforms. +:doc:`This page ` shows how to set up +``ytdl-sub`` to run automatically on various platforms. ...download large channels? ~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/guides/getting_started/automating.rst b/docs/source/guides/getting_started/automating_downloads.rst similarity index 100% rename from docs/source/guides/getting_started/automating.rst rename to docs/source/guides/getting_started/automating_downloads.rst diff --git a/docs/source/guides/getting_started/quick_start.rst b/docs/source/guides/getting_started/quick_start.rst index 8c92986b..7647f774 100644 --- a/docs/source/guides/getting_started/quick_start.rst +++ b/docs/source/guides/getting_started/quick_start.rst @@ -50,5 +50,5 @@ instructions to the letter. #. Automate downloads: - :ref:`Set up ytdl-sub to run periodically `. + :ref:`Set up ytdl-sub to run periodically + `. diff --git a/docs/source/guides/install/docker.rst b/docs/source/guides/install/docker.rst index f8162832..319bdefe 100644 --- a/docs/source/guides/install/docker.rst +++ b/docs/source/guides/install/docker.rst @@ -7,8 +7,8 @@ on top. There are two flavors or variants to choose from. For a more user-friend experience editing the `configuration`_, we recommend the `GUI image`_ variant. :ref:`Docker Compose ` is the recommended way of managing a ``ytdl-sub`` docker container. See :ref:`Automating -Downloads ` for how to automate -running ``ytdl-sub`` in a container running either variant. +Downloads ` for how to +automate running ``ytdl-sub`` in a container running either variant. GUI Image @@ -28,8 +28,8 @@ Headless Image The headless image is based on LSIO's :lsio-gh:`docker-baseimage-alpine`. Once running, the default command just starts services including cron for :ref:`Automating Downloads -` but otherwise doesn't run -``ytdl-sub``. You may run arbitrary ``ytdl-sub`` commands using the +` but otherwise doesn't +run ``ytdl-sub``. You may run arbitrary ``ytdl-sub`` commands using the ``--rm --user="${PUID}:${PGID}" --entrypoint="ytdl-sub"`` options to either ``$ docker run`` or ``$ docker compose run``. Overriding the image's ``ENTRYPOINT`` is important so that cron doesn't run ``ytdl-sub`` while you're running it manually.