From 3d7b80cf41d64670b4354ec53e3f25b2650fd483 Mon Sep 17 00:00:00 2001 From: meisnate12 Date: Sun, 10 Apr 2022 01:48:23 -0400 Subject: [PATCH] [18] update Config Menu --- VERSION | 2 +- docs/conf.py | 31 +++++++++++++++---------------- docs/config/libraries.md | 5 +++-- docs/config/playlist.md | 32 -------------------------------- docs/metadata/metadata.md | 2 +- 5 files changed, 20 insertions(+), 52 deletions(-) delete mode 100644 docs/config/playlist.md diff --git a/VERSION b/VERSION index ff2e1cc7..1234f22b 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.16.3-develop17 +1.16.3-develop18 diff --git a/docs/conf.py b/docs/conf.py index b5a774af..1eb6049e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -140,25 +140,24 @@ html_theme_options = { ("_menu", "Config", [ ("Configuration File", "config/configuration"), ("_divider", ), - ("Libraries", "config/libraries"), - ("Playlists", "config/playlist"), + ("Libraries/Playlists", "config/libraries"), ("Path Types", "config/paths"), ("Operations", "config/operations"), ("Settings", "config/settings"), - ("_menu", "Services", [ - ("Webhooks Attributes", "config/webhooks"), - ("Plex Attributes", "config/plex"), - ("TMDb Attributes", "config/tmdb"), - ("Tautulli Attributes", "config/tautulli"), - ("OMDb Attributes", "config/omdb"), - ("MdbList Attributes", "config/mdblist"), - ("Notifiarr Attributes", "config/notifiarr"), - ("AniDB Attributes", "config/anidb"), - ("Radarr Attributes", "config/radarr"), - ("Sonarr Attributes", "config/sonarr"), - ("Trakt Attributes", "config/trakt"), - ("MyAnimeList Attributes", "config/myanimelist"), - ]), + ("Webhooks", "config/webhooks"), + ("_divider", ), + ("Plex", "config/plex"), + ("Tautulli", "config/tautulli"), + ("Radarr", "config/radarr"), + ("Sonarr", "config/sonarr"), + ("_divider", ), + ("TMDb", "config/tmdb"), + ("Trakt", "config/trakt"), + ("MdbList", "config/mdblist"), + ("OMDb", "config/omdb"), + ("AniDB", "config/anidb"), + ("MyAnimeList", "config/myanimelist"), + ("Notifiarr", "config/notifiarr"), ]), ("_menu", "Metadata", [ ("Metadata and Playlist Files", "metadata/metadata"), diff --git a/docs/config/libraries.md b/docs/config/libraries.md index 6e6c5b7d..5720df9d 100644 --- a/docs/config/libraries.md +++ b/docs/config/libraries.md @@ -88,7 +88,7 @@ The available attributes for each library are as follows: | [`sonarr`](sonarr) | Any `sonarr` attribute that overrides a global value | global | ❌ | | [`tautulli`](tautulli) | Any `tautulli` attribute that overrides a global value | global | ❌ | -#### Library Name +### Library Name Each library that the user wants Plex Meta Manager to interact with must be documented with a library attribute. A library attribute is represented by the mapping name (i.e. `Movies` or `TV Shows`), this must have a unique name that correlates with a library of the same name within the Plex Media Server. In the situation that two servers are being connected to which both have libraries of the same name, the `library_name` attribute can be utilized to specify the real Library Name, whilst the library attribute's mapping name can be made into a placeholder. This is showcased below:
@@ -119,12 +119,13 @@ plex: The `metadata_path` attribute is used to define [Metadata Files](../metadata/metadata) by specifying the path type and path of the files that will be executed against the parent library. See [Path Types](paths) for how to define them. By default, when `metadata_path` is missing the script will look within the root PMM directory for a metadata file called `.yml`. In this example, Plex Meta Manager will look for a file named `TV Shows.yml`. + ```yaml libraries: TV Shows: ``` -## Missing Path +### Missing Path The `missing_path` attribute is used to define where to save the "missing items" YAML file. This file is used to store information about media which is missing from the Plex library compared to what is expected from the Metadata file. diff --git a/docs/config/playlist.md b/docs/config/playlist.md deleted file mode 100644 index dbb71e54..00000000 --- a/docs/config/playlist.md +++ /dev/null @@ -1,32 +0,0 @@ -# Playlist Files - -## Overview - -As playlists are not tied to one specific library and can combine media from multiple libraries, they require their own special [Playlist File](../metadata/metadata) to work. - -You can define Playlist Files by using `playlist_files` mapper. They can either be on the local system, online at an url, or directly from the [Plex Meta Manager Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) repository. - -## Path Types - -In this example, four `playlist_files`attribute path types are defined: - -```yaml -playlist_files: - - file: config/playlists.yml - - folder: config/Playlists/ - - git: meisnate12/Playlists - - url: https://somewhere.com/Playlists.yml -``` -The four path types are outlined as follows: - -* `- file:` refers to a playlist file which is located within the system that PMM is being run from. -* `- folder:` refers to a directory containing playlist files which is located within the system that PMM is being run from. -* `- git:` refers to a playlist file which is hosted on GitHub. This file is assumed to be in the [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs) unless the user has specified a custom repository with the -* `- url:` refers to a playlist file which is hosted publicly on the internet. - -Within the above example, PMM will: - -* First, look within the root of the PMM directory (also known as `config/`) for a playlist file named `Playlists.yml`. If this file does not exist, PMM will skip the entry and move to the next one in the list. -* Then, look within the root of the PMM directory (also known as `config/`) for a directory called `Playlists`, and then load any playlist files within that directory. -* Then, look at the [meisnate12 folder](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12) within the GitHub Configs Repo for a file called `MovieCharts.yml` which it finds [here](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/meisnate12/Playlists.yml). -* Finally, load the playlist file located at `https://somewhere.com/Playlists.yml` \ No newline at end of file diff --git a/docs/metadata/metadata.md b/docs/metadata/metadata.md index 52d21814..1a41c575 100644 --- a/docs/metadata/metadata.md +++ b/docs/metadata/metadata.md @@ -25,7 +25,7 @@ These are the attributes which can be used within the Metadata File: Playlists are defined in one or more Playlist files that are mapped in the [Playlist Files Attribute](../config/playlist) within the Configuration File. -There are two attributes which can be utilized within the Playlist File: +These are the attributes which can be utilized within the Playlist File: | Attribute | Description | |:--------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------|