diff --git a/docs/source/conf.py b/docs/source/conf.py index d8857931..e0604c5f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -66,6 +66,7 @@ suppress_warnings = [ extlinks = { "yt-dlp": ("https://github.com/yt-dlp/yt-dlp/%s", "yt-dlp%s"), + "unraid": ("https://unraid.net/%s", "unraid%s"), } # -- Options for autodoc ---------------------------------------------------- diff --git a/docs/source/guides/install/docker.rst b/docs/source/guides/install/docker.rst index 3793eba9..b30950c7 100644 --- a/docs/source/guides/install/docker.rst +++ b/docs/source/guides/install/docker.rst @@ -1,7 +1,7 @@ +====== Docker ====== - Docker Compose -------------- .. _LSIO-based images: https://www.linuxserver.io/ diff --git a/docs/source/guides/install/index.rst b/docs/source/guides/install/index.rst index d9060b46..ff1d293f 100644 --- a/docs/source/guides/install/index.rst +++ b/docs/source/guides/install/index.rst @@ -4,9 +4,29 @@ Install by Platform All installations require a 64-bit CPU. 32-bit is not supported. +.. margin:: + + .. tip:: + + The recommended install method of ``ytdl-sub`` is one of our :doc:`docker containers `. For install on Unraid, check out our :unraid:`unraid community apps `. + +:doc:`/guides/install/docker` + +:doc:`/guides/install/unraid` + +:doc:`/guides/install/linux` + +:doc:`/guides/install/windows` + +:doc:`/guides/install/agnostic` + + + Once you've completed your installation, please refer to the :doc:`../getting_started/index` guide for next steps .. toctree:: + :hidden: + docker linux unraid diff --git a/docs/source/guides/install/linux.rst b/docs/source/guides/install/linux.rst index 6990ae98..60c7f5c1 100644 --- a/docs/source/guides/install/linux.rst +++ b/docs/source/guides/install/linux.rst @@ -1,5 +1,6 @@ +===== Linux --------------- +===== Requires ffmpeg as a dependency. Can typically be installed with any Linux package manager. .. code-block:: bash @@ -22,7 +23,7 @@ You can also install using yt-dlp's ffmpeg builds. This ensures your ffmpeg is u mv ffmpeg-master-latest-linux64-gpl/bin/ffprobe /usr/bin/ffprobe Linux ARM --------------- +========= Requires ffmpeg as a dependency. Can typically be installed with any Linux package manager. .. code-block:: bash