diff --git a/README.md b/README.md index fbc35e59..f2ba4fd5 100644 --- a/README.md +++ b/README.md @@ -186,24 +186,24 @@ Any part of this process is modifiable by using custom configs. See our on how to build your first config from scratch. Ready-to-use [example configurations](https://github.com/jmbannon/ytdl-sub/tree/master/examples) can be found here alongside our -[readthedocs](https://ytdl-sub.readthedocs.io/en/latest/config.html#) +[readthedocs](https://ytdl-sub.readthedocs.io/en/latest/index.html) for detailed information on all config fields. ## Installation `ytdl-sub` can be installed on the following platforms. -- [Docker Compose](https://ytdl-sub.readthedocs.io/en/latest/install.html#docker-compose) - - [Web-GUI](https://ytdl-sub.readthedocs.io/en/latest/install.html#gui) - - [Headless](https://ytdl-sub.readthedocs.io/en/latest/install.html#headless) - - [CPU / GPU Passthrough](https://ytdl-sub.readthedocs.io/en/latest/install.html#passthrough) -- [Docker CLI](https://ytdl-sub.readthedocs.io/en/latest/install.html#docker) -- [Windows](https://ytdl-sub.readthedocs.io/en/latest/install.html#windows) -- [Unraid](https://ytdl-sub.readthedocs.io/en/latest/install.html#unraid) -- [Linux](https://ytdl-sub.readthedocs.io/en/latest/install.html#linux) -- [Linux ARM](https://ytdl-sub.readthedocs.io/en/latest/install.html#linux-arm) -- [PIP](https://ytdl-sub.readthedocs.io/en/latest/install.html#pip) -- [Local Install](https://ytdl-sub.readthedocs.io/en/latest/install.html#local-install) -- [Local Docker Build](https://ytdl-sub.readthedocs.io/en/latest/install.html#local-docker-build) +- [Docker Compose](https://ytdl-sub.readthedocs.io/en/latest/guides/install/docker.html#install-with-docker-compose) + - [Web-GUI](https://ytdl-sub.readthedocs.io/en/latest/guides/install/docker.html#install-with-docker-compose) + - [Headless](https://ytdl-sub.readthedocs.io/en/latest/guides/install/docker.html#install-with-docker-compose) + - [CPU / GPU Passthrough](https://ytdl-sub.readthedocs.io/en/latest/guides/install/docker.html#device-passthrough) +- [Docker CLI](https://ytdl-sub.readthedocs.io/en/latest/guides/install/docker.html#docker-cli) +- [Windows](https://ytdl-sub.readthedocs.io/en/latest/guides/install/windows.html) +- [Unraid](https://ytdl-sub.readthedocs.io/en/latest/guides/install/unraid.html) +- [Linux](https://ytdl-sub.readthedocs.io/en/latest/guides/install/linux.html) +- [Linux ARM](https://ytdl-sub.readthedocs.io/en/latest/guides/install/linux.html) +- [PIP](https://ytdl-sub.readthedocs.io/en/latest/guides/install/agnostic.html#pip-install) +- [Local Install](https://ytdl-sub.readthedocs.io/en/latest/guides/install/agnostic.html#local-install) +- [Local Docker Build](https://ytdl-sub.readthedocs.io/en/latest/guides/install/agnostic.html#local-docker-build) ### Docker Installation Docker installs can be either headless or use the Web-GUI image, which comprises @@ -223,5 +223,5 @@ pick up a bug. We are pretty active in our [Discord channel](https://discord.gg/v8j9RAHb4k) if you have any questions. Also see our -[FAQ](https://github.com/jmbannon/ytdl-sub/wiki/FAQ) +[FAQ](https://ytdl-sub.readthedocs.io/en/latest/faq/index.html) for commonly asked questions. diff --git a/docs/source/index.rst b/docs/source/index.rst index 5f8d748d..2fda8ee7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -13,10 +13,4 @@ ytdl-sub User Guide faq/index deprecation_notices -.. note:: End goal similar to: https://picard-docs.musicbrainz.org/en/functions/list_by_type.html - Initial plans: - - - pages for each prebuilt preset, showing which variables that can be overridden to do different things (i.e. episode_title) - - new wiki walkthrough that uses the README config as a starting point, and gradually adds custom changes - - pages for how to enable custom metadata agents for Kodi/Plex/jellyfin - - page dedicated to explaining the structure of a config (it's only lightly touched on now, many folks struggle to understand the 'pattern' of presets/plugins/overrides) +.. note:: The docs are heavily work-in-progress. Please bear with us while we're under construction! \ No newline at end of file diff --git a/src/ytdl_sub/utils/file_lock.py b/src/ytdl_sub/utils/file_lock.py index e78209dc..a766dd6c 100644 --- a/src/ytdl_sub/utils/file_lock.py +++ b/src/ytdl_sub/utils/file_lock.py @@ -53,7 +53,7 @@ else: "colliding with each other. If you get this error, it typically means it tried to " "create the file in a directory that is not a part of the same filesystem that " "ytdl-sub is running on. See " - "https://ytdl-sub.readthedocs.io/en/latest/config.html#ytdl_sub.config.config_validator.ConfigOptions.lock_directory " + "https://ytdl-sub.readthedocs.io/en/latest/config_reference/config_yaml.html " "on how to change the directory that this lock gets written to." ) from exc # pylint: enable=line-too-long